blob: 18b50fc1872b20960015c4c3e9e34f9e2514cc96 [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;
166 tuple = Py_BuildValue("OO", 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;
Guido van Rossum19a02ba2003-04-15 22:09:45 +0000261 PyArg_ParseTuple(PyList_GET_ITEM(temp, i),
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000262 "OO", &cls, &mro);
263 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:
306 type->tp_bases = old_bases;
307 type->tp_base = old_base;
308 type->tp_mro = old_mro;
Tim Petersea7f75d2002-12-07 21:39:16 +0000309
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000310 Py_DECREF(value);
311 Py_DECREF(new_base);
Tim Petersea7f75d2002-12-07 21:39:16 +0000312
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000313 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000314}
315
316static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000317type_dict(PyTypeObject *type, void *context)
318{
319 if (type->tp_dict == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000320 Py_INCREF(Py_None);
321 return Py_None;
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000322 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000323 return PyDictProxy_New(type->tp_dict);
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000324}
325
Tim Peters24008312002-03-17 18:56:20 +0000326static PyObject *
327type_get_doc(PyTypeObject *type, void *context)
328{
329 PyObject *result;
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000330 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE) && type->tp_doc != NULL)
Tim Peters24008312002-03-17 18:56:20 +0000331 return PyString_FromString(type->tp_doc);
Tim Peters24008312002-03-17 18:56:20 +0000332 result = PyDict_GetItemString(type->tp_dict, "__doc__");
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000333 if (result == NULL) {
334 result = Py_None;
335 Py_INCREF(result);
336 }
337 else if (result->ob_type->tp_descr_get) {
Tim Peters2b858972002-04-18 04:12:28 +0000338 result = result->ob_type->tp_descr_get(result, NULL,
339 (PyObject *)type);
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000340 }
341 else {
342 Py_INCREF(result);
343 }
Tim Peters24008312002-03-17 18:56:20 +0000344 return result;
345}
346
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000347static PyGetSetDef type_getsets[] = {
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000348 {"__name__", (getter)type_name, (setter)type_set_name, NULL},
349 {"__bases__", (getter)type_get_bases, (setter)type_set_bases, NULL},
Guido van Rossum3926a632001-09-25 16:25:58 +0000350 {"__module__", (getter)type_module, (setter)type_set_module, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000351 {"__dict__", (getter)type_dict, NULL, NULL},
Tim Peters24008312002-03-17 18:56:20 +0000352 {"__doc__", (getter)type_get_doc, NULL, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000353 {0}
354};
355
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000356static int
357type_compare(PyObject *v, PyObject *w)
358{
359 /* This is called with type objects only. So we
360 can just compare the addresses. */
361 Py_uintptr_t vv = (Py_uintptr_t)v;
362 Py_uintptr_t ww = (Py_uintptr_t)w;
363 return (vv < ww) ? -1 : (vv > ww) ? 1 : 0;
364}
365
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000366static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000367type_repr(PyTypeObject *type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000368{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000369 PyObject *mod, *name, *rtn;
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000370 char *kind;
Guido van Rossumc3542212001-08-16 09:18:56 +0000371
372 mod = type_module(type, NULL);
373 if (mod == NULL)
374 PyErr_Clear();
375 else if (!PyString_Check(mod)) {
376 Py_DECREF(mod);
377 mod = NULL;
378 }
379 name = type_name(type, NULL);
380 if (name == NULL)
381 return NULL;
Barry Warsaw7ce36942001-08-24 18:34:26 +0000382
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000383 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
384 kind = "class";
385 else
386 kind = "type";
387
Barry Warsaw7ce36942001-08-24 18:34:26 +0000388 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__")) {
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000389 rtn = PyString_FromFormat("<%s '%s.%s'>",
390 kind,
Barry Warsaw7ce36942001-08-24 18:34:26 +0000391 PyString_AS_STRING(mod),
392 PyString_AS_STRING(name));
393 }
Guido van Rossumc3542212001-08-16 09:18:56 +0000394 else
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000395 rtn = PyString_FromFormat("<%s '%s'>", kind, type->tp_name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000396
Guido van Rossumc3542212001-08-16 09:18:56 +0000397 Py_XDECREF(mod);
398 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000399 return rtn;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000400}
401
Tim Peters6d6c1a32001-08-02 04:15:00 +0000402static PyObject *
403type_call(PyTypeObject *type, PyObject *args, PyObject *kwds)
404{
405 PyObject *obj;
406
407 if (type->tp_new == NULL) {
408 PyErr_Format(PyExc_TypeError,
409 "cannot create '%.100s' instances",
410 type->tp_name);
411 return NULL;
412 }
413
Tim Peters3f996e72001-09-13 19:18:27 +0000414 obj = type->tp_new(type, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000415 if (obj != NULL) {
Guido van Rossumf76de622001-10-18 15:49:21 +0000416 /* Ugly exception: when the call was type(something),
417 don't call tp_init on the result. */
418 if (type == &PyType_Type &&
419 PyTuple_Check(args) && PyTuple_GET_SIZE(args) == 1 &&
420 (kwds == NULL ||
421 (PyDict_Check(kwds) && PyDict_Size(kwds) == 0)))
422 return obj;
Guido van Rossum8ace1ab2002-04-06 01:05:01 +0000423 /* If the returned object is not an instance of type,
424 it won't be initialized. */
425 if (!PyType_IsSubtype(obj->ob_type, type))
426 return obj;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000427 type = obj->ob_type;
Jeremy Hylton719841e2002-07-16 19:39:38 +0000428 if (PyType_HasFeature(type, Py_TPFLAGS_HAVE_CLASS) &&
429 type->tp_init != NULL &&
Tim Peters6d6c1a32001-08-02 04:15:00 +0000430 type->tp_init(obj, args, kwds) < 0) {
431 Py_DECREF(obj);
432 obj = NULL;
433 }
434 }
435 return obj;
436}
437
438PyObject *
439PyType_GenericAlloc(PyTypeObject *type, int nitems)
440{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000441 PyObject *obj;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000442 const size_t size = _PyObject_VAR_SIZE(type, nitems+1);
443 /* note that we need to add one, for the sentinel */
Tim Peters406fe3b2001-10-06 19:04:01 +0000444
445 if (PyType_IS_GC(type))
Neil Schemenauer09a2ae52002-04-12 03:06:53 +0000446 obj = _PyObject_GC_Malloc(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000447 else
Neil Schemenauerc806c882001-08-29 23:54:54 +0000448 obj = PyObject_MALLOC(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000449
Neil Schemenauerc806c882001-08-29 23:54:54 +0000450 if (obj == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000451 return PyErr_NoMemory();
Tim Peters406fe3b2001-10-06 19:04:01 +0000452
Neil Schemenauerc806c882001-08-29 23:54:54 +0000453 memset(obj, '\0', size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000454
Tim Peters6d6c1a32001-08-02 04:15:00 +0000455 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
456 Py_INCREF(type);
Tim Peters406fe3b2001-10-06 19:04:01 +0000457
Tim Peters6d6c1a32001-08-02 04:15:00 +0000458 if (type->tp_itemsize == 0)
459 PyObject_INIT(obj, type);
460 else
461 (void) PyObject_INIT_VAR((PyVarObject *)obj, type, nitems);
Tim Peters406fe3b2001-10-06 19:04:01 +0000462
Tim Peters6d6c1a32001-08-02 04:15:00 +0000463 if (PyType_IS_GC(type))
Neil Schemenauerc806c882001-08-29 23:54:54 +0000464 _PyObject_GC_TRACK(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000465 return obj;
466}
467
468PyObject *
469PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
470{
471 return type->tp_alloc(type, 0);
472}
473
Guido van Rossum9475a232001-10-05 20:51:39 +0000474/* Helpers for subtyping */
475
476static int
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000477traverse_slots(PyTypeObject *type, PyObject *self, visitproc visit, void *arg)
478{
479 int i, n;
480 PyMemberDef *mp;
481
482 n = type->ob_size;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000483 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000484 for (i = 0; i < n; i++, mp++) {
485 if (mp->type == T_OBJECT_EX) {
486 char *addr = (char *)self + mp->offset;
487 PyObject *obj = *(PyObject **)addr;
488 if (obj != NULL) {
489 int err = visit(obj, arg);
490 if (err)
491 return err;
492 }
493 }
494 }
495 return 0;
496}
497
498static int
Guido van Rossum9475a232001-10-05 20:51:39 +0000499subtype_traverse(PyObject *self, visitproc visit, void *arg)
500{
501 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000502 traverseproc basetraverse;
Guido van Rossum9475a232001-10-05 20:51:39 +0000503
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000504 /* Find the nearest base with a different tp_traverse,
505 and traverse slots while we're at it */
Guido van Rossum9475a232001-10-05 20:51:39 +0000506 type = self->ob_type;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000507 base = type;
508 while ((basetraverse = base->tp_traverse) == subtype_traverse) {
509 if (base->ob_size) {
510 int err = traverse_slots(base, self, visit, arg);
511 if (err)
512 return err;
513 }
Guido van Rossum9475a232001-10-05 20:51:39 +0000514 base = base->tp_base;
515 assert(base);
516 }
517
518 if (type->tp_dictoffset != base->tp_dictoffset) {
519 PyObject **dictptr = _PyObject_GetDictPtr(self);
520 if (dictptr && *dictptr) {
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000521 int err = visit(*dictptr, arg);
Guido van Rossum9475a232001-10-05 20:51:39 +0000522 if (err)
523 return err;
524 }
525 }
526
Guido van Rossuma3862092002-06-10 15:24:42 +0000527 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE) {
528 /* For a heaptype, the instances count as references
529 to the type. Traverse the type so the collector
530 can find cycles involving this link. */
531 int err = visit((PyObject *)type, arg);
532 if (err)
533 return err;
534 }
535
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000536 if (basetraverse)
537 return basetraverse(self, visit, arg);
538 return 0;
539}
540
541static void
542clear_slots(PyTypeObject *type, PyObject *self)
543{
544 int i, n;
545 PyMemberDef *mp;
546
547 n = type->ob_size;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000548 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000549 for (i = 0; i < n; i++, mp++) {
550 if (mp->type == T_OBJECT_EX && !(mp->flags & READONLY)) {
551 char *addr = (char *)self + mp->offset;
552 PyObject *obj = *(PyObject **)addr;
553 if (obj != NULL) {
554 Py_DECREF(obj);
555 *(PyObject **)addr = NULL;
556 }
557 }
558 }
559}
560
561static int
562subtype_clear(PyObject *self)
563{
564 PyTypeObject *type, *base;
565 inquiry baseclear;
566
567 /* Find the nearest base with a different tp_clear
568 and clear slots while we're at it */
569 type = self->ob_type;
570 base = type;
571 while ((baseclear = base->tp_clear) == subtype_clear) {
572 if (base->ob_size)
573 clear_slots(base, self);
574 base = base->tp_base;
575 assert(base);
576 }
577
Guido van Rossuma3862092002-06-10 15:24:42 +0000578 /* There's no need to clear the instance dict (if any);
579 the collector will call its tp_clear handler. */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000580
581 if (baseclear)
582 return baseclear(self);
Guido van Rossum9475a232001-10-05 20:51:39 +0000583 return 0;
584}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000585
586static void
587subtype_dealloc(PyObject *self)
588{
Guido van Rossum14227b42001-12-06 02:35:58 +0000589 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000590 destructor basedealloc;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000591
Guido van Rossum22b13872002-08-06 21:41:44 +0000592 /* Extract the type; we expect it to be a heap type */
593 type = self->ob_type;
594 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000595
Guido van Rossum22b13872002-08-06 21:41:44 +0000596 /* Test whether the type has GC exactly once */
597
598 if (!PyType_IS_GC(type)) {
599 /* It's really rare to find a dynamic type that doesn't have
600 GC; it can only happen when deriving from 'object' and not
601 adding any slots or instance variables. This allows
602 certain simplifications: there's no need to call
603 clear_slots(), or DECREF the dict, or clear weakrefs. */
604
605 /* Maybe call finalizer; exit early if resurrected */
Guido van Rossumfebd61d2002-08-08 20:55:20 +0000606 if (type->tp_del) {
607 type->tp_del(self);
608 if (self->ob_refcnt > 0)
609 return;
610 }
Guido van Rossum22b13872002-08-06 21:41:44 +0000611
612 /* Find the nearest base with a different tp_dealloc */
613 base = type;
614 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
615 assert(base->ob_size == 0);
616 base = base->tp_base;
617 assert(base);
618 }
619
620 /* Call the base tp_dealloc() */
621 assert(basedealloc);
622 basedealloc(self);
623
624 /* Can't reference self beyond this point */
625 Py_DECREF(type);
626
627 /* Done */
628 return;
629 }
630
631 /* We get here only if the type has GC */
632
633 /* UnTrack and re-Track around the trashcan macro, alas */
Andrew M. Kuchlingc9172d32003-02-06 15:22:49 +0000634 /* See explanation at end of function for full disclosure */
Guido van Rossum0906e072002-08-07 20:42:09 +0000635 PyObject_GC_UnTrack(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000636 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000637 Py_TRASHCAN_SAFE_BEGIN(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000638 --_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000639 _PyObject_GC_TRACK(self); /* We'll untrack for real later */
640
641 /* Maybe call finalizer; exit early if resurrected */
Guido van Rossumfebd61d2002-08-08 20:55:20 +0000642 if (type->tp_del) {
643 type->tp_del(self);
644 if (self->ob_refcnt > 0)
645 goto endlabel;
646 }
Guido van Rossum7ad2d1e2001-10-29 22:11:00 +0000647
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000648 /* Find the nearest base with a different tp_dealloc
649 and clear slots while we're at it */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000650 base = type;
651 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
652 if (base->ob_size)
653 clear_slots(base, self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000654 base = base->tp_base;
655 assert(base);
Guido van Rossum14227b42001-12-06 02:35:58 +0000656 }
657
Tim Peters6d6c1a32001-08-02 04:15:00 +0000658 /* If we added a dict, DECREF it */
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000659 if (type->tp_dictoffset && !base->tp_dictoffset) {
660 PyObject **dictptr = _PyObject_GetDictPtr(self);
661 if (dictptr != NULL) {
662 PyObject *dict = *dictptr;
663 if (dict != NULL) {
664 Py_DECREF(dict);
665 *dictptr = NULL;
666 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000667 }
668 }
669
Guido van Rossum9676b222001-08-17 20:32:36 +0000670 /* If we added weaklist, we clear it */
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000671 if (type->tp_weaklistoffset && !base->tp_weaklistoffset)
Guido van Rossum9676b222001-08-17 20:32:36 +0000672 PyObject_ClearWeakRefs(self);
673
Tim Peters6d6c1a32001-08-02 04:15:00 +0000674 /* Finalize GC if the base doesn't do GC and we do */
Guido van Rossum22b13872002-08-06 21:41:44 +0000675 if (!PyType_IS_GC(base))
Guido van Rossum048eb752001-10-02 21:24:57 +0000676 _PyObject_GC_UNTRACK(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000677
678 /* Call the base tp_dealloc() */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000679 assert(basedealloc);
680 basedealloc(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000681
682 /* Can't reference self beyond this point */
Guido van Rossum22b13872002-08-06 21:41:44 +0000683 Py_DECREF(type);
684
Guido van Rossum0906e072002-08-07 20:42:09 +0000685 endlabel:
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000686 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000687 Py_TRASHCAN_SAFE_END(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000688 --_PyTrash_delete_nesting;
689
690 /* Explanation of the weirdness around the trashcan macros:
691
692 Q. What do the trashcan macros do?
693
694 A. Read the comment titled "Trashcan mechanism" in object.h.
695 For one, this explains why there must be a call to GC-untrack
696 before the trashcan begin macro. Without understanding the
697 trashcan code, the answers to the following questions don't make
698 sense.
699
700 Q. Why do we GC-untrack before the trashcan and then immediately
701 GC-track again afterward?
702
703 A. In the case that the base class is GC-aware, the base class
704 probably GC-untracks the object. If it does that using the
705 UNTRACK macro, this will crash when the object is already
706 untracked. Because we don't know what the base class does, the
707 only safe thing is to make sure the object is tracked when we
708 call the base class dealloc. But... The trashcan begin macro
709 requires that the object is *untracked* before it is called. So
710 the dance becomes:
711
712 GC untrack
713 trashcan begin
714 GC track
715
716 Q. Why the bizarre (net-zero) manipulation of
717 _PyTrash_delete_nesting around the trashcan macros?
718
719 A. Some base classes (e.g. list) also use the trashcan mechanism.
720 The following scenario used to be possible:
721
722 - suppose the trashcan level is one below the trashcan limit
723
724 - subtype_dealloc() is called
725
726 - the trashcan limit is not yet reached, so the trashcan level
727 is incremented and the code between trashcan begin and end is
728 executed
729
730 - this destroys much of the object's contents, including its
731 slots and __dict__
732
733 - basedealloc() is called; this is really list_dealloc(), or
734 some other type which also uses the trashcan macros
735
736 - the trashcan limit is now reached, so the object is put on the
737 trashcan's to-be-deleted-later list
738
739 - basedealloc() returns
740
741 - subtype_dealloc() decrefs the object's type
742
743 - subtype_dealloc() returns
744
745 - later, the trashcan code starts deleting the objects from its
746 to-be-deleted-later list
747
748 - subtype_dealloc() is called *AGAIN* for the same object
749
750 - at the very least (if the destroyed slots and __dict__ don't
751 cause problems) the object's type gets decref'ed a second
752 time, which is *BAD*!!!
753
754 The remedy is to make sure that if the code between trashcan
755 begin and end in subtype_dealloc() is called, the code between
756 trashcan begin and end in basedealloc() will also be called.
757 This is done by decrementing the level after passing into the
758 trashcan block, and incrementing it just before leaving the
759 block.
760
761 But now it's possible that a chain of objects consisting solely
762 of objects whose deallocator is subtype_dealloc() will defeat
763 the trashcan mechanism completely: the decremented level means
764 that the effective level never reaches the limit. Therefore, we
765 *increment* the level *before* entering the trashcan block, and
766 matchingly decrement it after leaving. This means the trashcan
767 code will trigger a little early, but that's no big deal.
768
769 Q. Are there any live examples of code in need of all this
770 complexity?
771
772 A. Yes. See SF bug 668433 for code that crashed (when Python was
773 compiled in debug mode) before the trashcan level manipulations
774 were added. For more discussion, see SF patches 581742, 575073
775 and bug 574207.
776 */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000777}
778
Jeremy Hylton938ace62002-07-17 16:30:39 +0000779static PyTypeObject *solid_base(PyTypeObject *type);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000780
Tim Peters6d6c1a32001-08-02 04:15:00 +0000781/* type test with subclassing support */
782
783int
784PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)
785{
786 PyObject *mro;
787
Guido van Rossum9478d072001-09-07 18:52:13 +0000788 if (!(a->tp_flags & Py_TPFLAGS_HAVE_CLASS))
789 return b == a || b == &PyBaseObject_Type;
790
Tim Peters6d6c1a32001-08-02 04:15:00 +0000791 mro = a->tp_mro;
792 if (mro != NULL) {
793 /* Deal with multiple inheritance without recursion
794 by walking the MRO tuple */
795 int i, n;
796 assert(PyTuple_Check(mro));
797 n = PyTuple_GET_SIZE(mro);
798 for (i = 0; i < n; i++) {
799 if (PyTuple_GET_ITEM(mro, i) == (PyObject *)b)
800 return 1;
801 }
802 return 0;
803 }
804 else {
805 /* a is not completely initilized yet; follow tp_base */
806 do {
807 if (a == b)
808 return 1;
809 a = a->tp_base;
810 } while (a != NULL);
811 return b == &PyBaseObject_Type;
812 }
813}
814
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000815/* Internal routines to do a method lookup in the type
Guido van Rossum60718732001-08-28 17:47:51 +0000816 without looking in the instance dictionary
817 (so we can't use PyObject_GetAttr) but still binding
818 it to the instance. The arguments are the object,
819 the method name as a C string, and the address of a
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000820 static variable used to cache the interned Python string.
821
822 Two variants:
823
824 - lookup_maybe() returns NULL without raising an exception
825 when the _PyType_Lookup() call fails;
826
827 - lookup_method() always raises an exception upon errors.
828*/
Guido van Rossum60718732001-08-28 17:47:51 +0000829
830static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000831lookup_maybe(PyObject *self, char *attrstr, PyObject **attrobj)
Guido van Rossum60718732001-08-28 17:47:51 +0000832{
833 PyObject *res;
834
835 if (*attrobj == NULL) {
836 *attrobj = PyString_InternFromString(attrstr);
837 if (*attrobj == NULL)
838 return NULL;
839 }
840 res = _PyType_Lookup(self->ob_type, *attrobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000841 if (res != NULL) {
Guido van Rossum60718732001-08-28 17:47:51 +0000842 descrgetfunc f;
843 if ((f = res->ob_type->tp_descr_get) == NULL)
844 Py_INCREF(res);
845 else
846 res = f(res, self, (PyObject *)(self->ob_type));
847 }
848 return res;
849}
850
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000851static PyObject *
852lookup_method(PyObject *self, char *attrstr, PyObject **attrobj)
853{
854 PyObject *res = lookup_maybe(self, attrstr, attrobj);
855 if (res == NULL && !PyErr_Occurred())
856 PyErr_SetObject(PyExc_AttributeError, *attrobj);
857 return res;
858}
859
Guido van Rossum2730b132001-08-28 18:22:14 +0000860/* A variation of PyObject_CallMethod that uses lookup_method()
861 instead of PyObject_GetAttrString(). This uses the same convention
862 as lookup_method to cache the interned name string object. */
863
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000864static PyObject *
Guido van Rossum2730b132001-08-28 18:22:14 +0000865call_method(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
866{
867 va_list va;
868 PyObject *args, *func = 0, *retval;
Guido van Rossum2730b132001-08-28 18:22:14 +0000869 va_start(va, format);
870
Guido van Rossumda21c012001-10-03 00:50:18 +0000871 func = lookup_maybe(o, name, nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000872 if (func == NULL) {
873 va_end(va);
874 if (!PyErr_Occurred())
Guido van Rossumda21c012001-10-03 00:50:18 +0000875 PyErr_SetObject(PyExc_AttributeError, *nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000876 return NULL;
877 }
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000878
879 if (format && *format)
880 args = Py_VaBuildValue(format, va);
881 else
882 args = PyTuple_New(0);
883
884 va_end(va);
885
886 if (args == NULL)
887 return NULL;
888
889 assert(PyTuple_Check(args));
890 retval = PyObject_Call(func, args, NULL);
891
892 Py_DECREF(args);
893 Py_DECREF(func);
894
895 return retval;
896}
897
898/* Clone of call_method() that returns NotImplemented when the lookup fails. */
899
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000900static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000901call_maybe(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
902{
903 va_list va;
904 PyObject *args, *func = 0, *retval;
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000905 va_start(va, format);
906
Guido van Rossumda21c012001-10-03 00:50:18 +0000907 func = lookup_maybe(o, name, nameobj);
Guido van Rossum2730b132001-08-28 18:22:14 +0000908 if (func == NULL) {
909 va_end(va);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000910 if (!PyErr_Occurred()) {
911 Py_INCREF(Py_NotImplemented);
912 return Py_NotImplemented;
913 }
Guido van Rossum717ce002001-09-14 16:58:08 +0000914 return NULL;
Guido van Rossum2730b132001-08-28 18:22:14 +0000915 }
916
917 if (format && *format)
918 args = Py_VaBuildValue(format, va);
919 else
920 args = PyTuple_New(0);
921
922 va_end(va);
923
Guido van Rossum717ce002001-09-14 16:58:08 +0000924 if (args == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +0000925 return NULL;
926
Guido van Rossum717ce002001-09-14 16:58:08 +0000927 assert(PyTuple_Check(args));
928 retval = PyObject_Call(func, args, NULL);
Guido van Rossum2730b132001-08-28 18:22:14 +0000929
930 Py_DECREF(args);
931 Py_DECREF(func);
932
933 return retval;
934}
935
Tim Petersa91e9642001-11-14 23:32:33 +0000936static int
937fill_classic_mro(PyObject *mro, PyObject *cls)
938{
939 PyObject *bases, *base;
940 int i, n;
941
942 assert(PyList_Check(mro));
943 assert(PyClass_Check(cls));
944 i = PySequence_Contains(mro, cls);
945 if (i < 0)
946 return -1;
947 if (!i) {
948 if (PyList_Append(mro, cls) < 0)
949 return -1;
950 }
951 bases = ((PyClassObject *)cls)->cl_bases;
952 assert(bases && PyTuple_Check(bases));
953 n = PyTuple_GET_SIZE(bases);
954 for (i = 0; i < n; i++) {
955 base = PyTuple_GET_ITEM(bases, i);
956 if (fill_classic_mro(mro, base) < 0)
957 return -1;
958 }
959 return 0;
960}
961
962static PyObject *
963classic_mro(PyObject *cls)
964{
965 PyObject *mro;
966
967 assert(PyClass_Check(cls));
968 mro = PyList_New(0);
969 if (mro != NULL) {
970 if (fill_classic_mro(mro, cls) == 0)
971 return mro;
972 Py_DECREF(mro);
973 }
974 return NULL;
975}
976
Tim Petersea7f75d2002-12-07 21:39:16 +0000977/*
Guido van Rossum1f121312002-11-14 19:49:16 +0000978 Method resolution order algorithm C3 described in
979 "A Monotonic Superclass Linearization for Dylan",
980 by Kim Barrett, Bob Cassel, Paul Haahr,
Tim Petersea7f75d2002-12-07 21:39:16 +0000981 David A. Moon, Keith Playford, and P. Tucker Withington.
Guido van Rossum1f121312002-11-14 19:49:16 +0000982 (OOPSLA 1996)
983
Guido van Rossum98f33732002-11-25 21:36:54 +0000984 Some notes about the rules implied by C3:
985
Tim Petersea7f75d2002-12-07 21:39:16 +0000986 No duplicate bases.
Guido van Rossum98f33732002-11-25 21:36:54 +0000987 It isn't legal to repeat a class in a list of base classes.
988
989 The next three properties are the 3 constraints in "C3".
990
Tim Petersea7f75d2002-12-07 21:39:16 +0000991 Local precendece order.
Guido van Rossum98f33732002-11-25 21:36:54 +0000992 If A precedes B in C's MRO, then A will precede B in the MRO of all
993 subclasses of C.
994
995 Monotonicity.
996 The MRO of a class must be an extension without reordering of the
997 MRO of each of its superclasses.
998
999 Extended Precedence Graph (EPG).
1000 Linearization is consistent if there is a path in the EPG from
1001 each class to all its successors in the linearization. See
1002 the paper for definition of EPG.
Guido van Rossum1f121312002-11-14 19:49:16 +00001003 */
1004
Tim Petersea7f75d2002-12-07 21:39:16 +00001005static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001006tail_contains(PyObject *list, int whence, PyObject *o) {
1007 int j, size;
1008 size = PyList_GET_SIZE(list);
1009
1010 for (j = whence+1; j < size; j++) {
1011 if (PyList_GET_ITEM(list, j) == o)
1012 return 1;
1013 }
1014 return 0;
1015}
1016
Guido van Rossum98f33732002-11-25 21:36:54 +00001017static PyObject *
1018class_name(PyObject *cls)
1019{
1020 PyObject *name = PyObject_GetAttrString(cls, "__name__");
1021 if (name == NULL) {
1022 PyErr_Clear();
1023 Py_XDECREF(name);
1024 name = PyObject_Repr(cls);
1025 }
1026 if (name == NULL)
1027 return NULL;
1028 if (!PyString_Check(name)) {
1029 Py_DECREF(name);
1030 return NULL;
1031 }
1032 return name;
1033}
1034
1035static int
1036check_duplicates(PyObject *list)
1037{
1038 int i, j, n;
1039 /* Let's use a quadratic time algorithm,
1040 assuming that the bases lists is short.
1041 */
1042 n = PyList_GET_SIZE(list);
1043 for (i = 0; i < n; i++) {
1044 PyObject *o = PyList_GET_ITEM(list, i);
1045 for (j = i + 1; j < n; j++) {
1046 if (PyList_GET_ITEM(list, j) == o) {
1047 o = class_name(o);
1048 PyErr_Format(PyExc_TypeError,
1049 "duplicate base class %s",
1050 o ? PyString_AS_STRING(o) : "?");
1051 Py_XDECREF(o);
1052 return -1;
1053 }
1054 }
1055 }
1056 return 0;
1057}
1058
1059/* Raise a TypeError for an MRO order disagreement.
1060
1061 It's hard to produce a good error message. In the absence of better
1062 insight into error reporting, report the classes that were candidates
1063 to be put next into the MRO. There is some conflict between the
1064 order in which they should be put in the MRO, but it's hard to
1065 diagnose what constraint can't be satisfied.
1066*/
1067
1068static void
1069set_mro_error(PyObject *to_merge, int *remain)
1070{
1071 int i, n, off, to_merge_size;
1072 char buf[1000];
1073 PyObject *k, *v;
1074 PyObject *set = PyDict_New();
1075
1076 to_merge_size = PyList_GET_SIZE(to_merge);
1077 for (i = 0; i < to_merge_size; i++) {
1078 PyObject *L = PyList_GET_ITEM(to_merge, i);
1079 if (remain[i] < PyList_GET_SIZE(L)) {
1080 PyObject *c = PyList_GET_ITEM(L, remain[i]);
1081 if (PyDict_SetItem(set, c, Py_None) < 0)
1082 return;
1083 }
1084 }
1085 n = PyDict_Size(set);
1086
Raymond Hettingerf394df42003-04-06 19:13:41 +00001087 off = PyOS_snprintf(buf, sizeof(buf), "Cannot create a \
1088consistent method resolution\norder (MRO) for bases");
Guido van Rossum98f33732002-11-25 21:36:54 +00001089 i = 0;
1090 while (PyDict_Next(set, &i, &k, &v) && off < sizeof(buf)) {
1091 PyObject *name = class_name(k);
1092 off += PyOS_snprintf(buf + off, sizeof(buf) - off, " %s",
1093 name ? PyString_AS_STRING(name) : "?");
1094 Py_XDECREF(name);
1095 if (--n && off+1 < sizeof(buf)) {
1096 buf[off++] = ',';
1097 buf[off] = '\0';
1098 }
1099 }
1100 PyErr_SetString(PyExc_TypeError, buf);
1101 Py_DECREF(set);
1102}
1103
Tim Petersea7f75d2002-12-07 21:39:16 +00001104static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001105pmerge(PyObject *acc, PyObject* to_merge) {
1106 int i, j, to_merge_size;
1107 int *remain;
1108 int ok, empty_cnt;
Tim Petersea7f75d2002-12-07 21:39:16 +00001109
Guido van Rossum1f121312002-11-14 19:49:16 +00001110 to_merge_size = PyList_GET_SIZE(to_merge);
1111
Guido van Rossum98f33732002-11-25 21:36:54 +00001112 /* remain stores an index into each sublist of to_merge.
1113 remain[i] is the index of the next base in to_merge[i]
1114 that is not included in acc.
1115 */
Guido van Rossum1f121312002-11-14 19:49:16 +00001116 remain = PyMem_MALLOC(SIZEOF_INT*to_merge_size);
1117 if (remain == NULL)
1118 return -1;
1119 for (i = 0; i < to_merge_size; i++)
1120 remain[i] = 0;
1121
1122 again:
1123 empty_cnt = 0;
1124 for (i = 0; i < to_merge_size; i++) {
1125 PyObject *candidate;
Tim Petersea7f75d2002-12-07 21:39:16 +00001126
Guido van Rossum1f121312002-11-14 19:49:16 +00001127 PyObject *cur_list = PyList_GET_ITEM(to_merge, i);
1128
1129 if (remain[i] >= PyList_GET_SIZE(cur_list)) {
1130 empty_cnt++;
1131 continue;
1132 }
1133
Guido van Rossum98f33732002-11-25 21:36:54 +00001134 /* Choose next candidate for MRO.
1135
1136 The input sequences alone can determine the choice.
1137 If not, choose the class which appears in the MRO
1138 of the earliest direct superclass of the new class.
1139 */
1140
Guido van Rossum1f121312002-11-14 19:49:16 +00001141 candidate = PyList_GET_ITEM(cur_list, remain[i]);
1142 for (j = 0; j < to_merge_size; j++) {
1143 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum98f33732002-11-25 21:36:54 +00001144 if (tail_contains(j_lst, remain[j], candidate)) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001145 goto skip; /* continue outer loop */
Guido van Rossum98f33732002-11-25 21:36:54 +00001146 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001147 }
1148 ok = PyList_Append(acc, candidate);
1149 if (ok < 0) {
1150 PyMem_Free(remain);
1151 return -1;
1152 }
1153 for (j = 0; j < to_merge_size; j++) {
1154 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum768158c2002-12-31 16:33:01 +00001155 if (remain[j] < PyList_GET_SIZE(j_lst) &&
1156 PyList_GET_ITEM(j_lst, remain[j]) == candidate) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001157 remain[j]++;
1158 }
1159 }
1160 goto again;
Tim Peters9a6b8d82002-11-14 23:22:33 +00001161 skip: ;
Guido van Rossum1f121312002-11-14 19:49:16 +00001162 }
1163
Guido van Rossum98f33732002-11-25 21:36:54 +00001164 if (empty_cnt == to_merge_size) {
1165 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001166 return 0;
Guido van Rossum98f33732002-11-25 21:36:54 +00001167 }
1168 set_mro_error(to_merge, remain);
1169 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001170 return -1;
1171}
1172
Tim Peters6d6c1a32001-08-02 04:15:00 +00001173static PyObject *
1174mro_implementation(PyTypeObject *type)
1175{
1176 int i, n, ok;
1177 PyObject *bases, *result;
Guido van Rossum1f121312002-11-14 19:49:16 +00001178 PyObject *to_merge, *bases_aslist;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001179
Guido van Rossum63517572002-06-18 16:44:57 +00001180 if(type->tp_dict == NULL) {
1181 if(PyType_Ready(type) < 0)
1182 return NULL;
1183 }
1184
Guido van Rossum98f33732002-11-25 21:36:54 +00001185 /* Find a superclass linearization that honors the constraints
1186 of the explicit lists of bases and the constraints implied by
Tim Petersea7f75d2002-12-07 21:39:16 +00001187 each base class.
Guido van Rossum98f33732002-11-25 21:36:54 +00001188
1189 to_merge is a list of lists, where each list is a superclass
1190 linearization implied by a base class. The last element of
1191 to_merge is the declared list of bases.
1192 */
1193
Tim Peters6d6c1a32001-08-02 04:15:00 +00001194 bases = type->tp_bases;
1195 n = PyTuple_GET_SIZE(bases);
Guido van Rossum1f121312002-11-14 19:49:16 +00001196
1197 to_merge = PyList_New(n+1);
1198 if (to_merge == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001199 return NULL;
Guido van Rossum1f121312002-11-14 19:49:16 +00001200
Tim Peters6d6c1a32001-08-02 04:15:00 +00001201 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001202 PyObject *base = PyTuple_GET_ITEM(bases, i);
1203 PyObject *parentMRO;
1204 if (PyType_Check(base))
1205 parentMRO = PySequence_List(
1206 ((PyTypeObject*)base)->tp_mro);
1207 else
1208 parentMRO = classic_mro(base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001209 if (parentMRO == NULL) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001210 Py_DECREF(to_merge);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001211 return NULL;
Guido van Rossum1f121312002-11-14 19:49:16 +00001212 }
1213
1214 PyList_SET_ITEM(to_merge, i, parentMRO);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001215 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001216
1217 bases_aslist = PySequence_List(bases);
1218 if (bases_aslist == NULL) {
1219 Py_DECREF(to_merge);
1220 return NULL;
1221 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001222 /* This is just a basic sanity check. */
1223 if (check_duplicates(bases_aslist) < 0) {
1224 Py_DECREF(to_merge);
1225 Py_DECREF(bases_aslist);
1226 return NULL;
1227 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001228 PyList_SET_ITEM(to_merge, n, bases_aslist);
1229
1230 result = Py_BuildValue("[O]", (PyObject *)type);
1231 if (result == NULL) {
1232 Py_DECREF(to_merge);
1233 return NULL;
1234 }
1235
1236 ok = pmerge(result, to_merge);
1237 Py_DECREF(to_merge);
1238 if (ok < 0) {
1239 Py_DECREF(result);
1240 return NULL;
1241 }
1242
Tim Peters6d6c1a32001-08-02 04:15:00 +00001243 return result;
1244}
1245
1246static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001247mro_external(PyObject *self)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001248{
1249 PyTypeObject *type = (PyTypeObject *)self;
1250
Tim Peters6d6c1a32001-08-02 04:15:00 +00001251 return mro_implementation(type);
1252}
1253
1254static int
1255mro_internal(PyTypeObject *type)
1256{
1257 PyObject *mro, *result, *tuple;
1258
1259 if (type->ob_type == &PyType_Type) {
1260 result = mro_implementation(type);
1261 }
1262 else {
Guido van Rossum60718732001-08-28 17:47:51 +00001263 static PyObject *mro_str;
1264 mro = lookup_method((PyObject *)type, "mro", &mro_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001265 if (mro == NULL)
1266 return -1;
1267 result = PyObject_CallObject(mro, NULL);
1268 Py_DECREF(mro);
1269 }
1270 if (result == NULL)
1271 return -1;
1272 tuple = PySequence_Tuple(result);
1273 Py_DECREF(result);
1274 type->tp_mro = tuple;
1275 return 0;
1276}
1277
1278
1279/* Calculate the best base amongst multiple base classes.
1280 This is the first one that's on the path to the "solid base". */
1281
1282static PyTypeObject *
1283best_base(PyObject *bases)
1284{
1285 int i, n;
1286 PyTypeObject *base, *winner, *candidate, *base_i;
Tim Petersa91e9642001-11-14 23:32:33 +00001287 PyObject *base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001288
1289 assert(PyTuple_Check(bases));
1290 n = PyTuple_GET_SIZE(bases);
1291 assert(n > 0);
Tim Petersa91e9642001-11-14 23:32:33 +00001292 base = NULL;
1293 winner = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001294 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001295 base_proto = PyTuple_GET_ITEM(bases, i);
1296 if (PyClass_Check(base_proto))
1297 continue;
1298 if (!PyType_Check(base_proto)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001299 PyErr_SetString(
1300 PyExc_TypeError,
1301 "bases must be types");
1302 return NULL;
1303 }
Tim Petersa91e9642001-11-14 23:32:33 +00001304 base_i = (PyTypeObject *)base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001305 if (base_i->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001306 if (PyType_Ready(base_i) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001307 return NULL;
1308 }
1309 candidate = solid_base(base_i);
Tim Petersa91e9642001-11-14 23:32:33 +00001310 if (winner == NULL) {
1311 winner = candidate;
1312 base = base_i;
1313 }
1314 else if (PyType_IsSubtype(winner, candidate))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001315 ;
1316 else if (PyType_IsSubtype(candidate, winner)) {
1317 winner = candidate;
1318 base = base_i;
1319 }
1320 else {
1321 PyErr_SetString(
1322 PyExc_TypeError,
1323 "multiple bases have "
1324 "instance lay-out conflict");
1325 return NULL;
1326 }
1327 }
Guido van Rossume54616c2001-12-14 04:19:56 +00001328 if (base == NULL)
1329 PyErr_SetString(PyExc_TypeError,
1330 "a new-style class can't have only classic bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001331 return base;
1332}
1333
1334static int
1335extra_ivars(PyTypeObject *type, PyTypeObject *base)
1336{
Neil Schemenauerc806c882001-08-29 23:54:54 +00001337 size_t t_size = type->tp_basicsize;
1338 size_t b_size = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001339
Guido van Rossum9676b222001-08-17 20:32:36 +00001340 assert(t_size >= b_size); /* Else type smaller than base! */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001341 if (type->tp_itemsize || base->tp_itemsize) {
1342 /* If itemsize is involved, stricter rules */
1343 return t_size != b_size ||
1344 type->tp_itemsize != base->tp_itemsize;
1345 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001346 if (type->tp_weaklistoffset && base->tp_weaklistoffset == 0 &&
1347 type->tp_weaklistoffset + sizeof(PyObject *) == t_size)
1348 t_size -= sizeof(PyObject *);
1349 if (type->tp_dictoffset && base->tp_dictoffset == 0 &&
1350 type->tp_dictoffset + sizeof(PyObject *) == t_size)
1351 t_size -= sizeof(PyObject *);
1352
1353 return t_size != b_size;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001354}
1355
1356static PyTypeObject *
1357solid_base(PyTypeObject *type)
1358{
1359 PyTypeObject *base;
1360
1361 if (type->tp_base)
1362 base = solid_base(type->tp_base);
1363 else
1364 base = &PyBaseObject_Type;
1365 if (extra_ivars(type, base))
1366 return type;
1367 else
1368 return base;
1369}
1370
Jeremy Hylton938ace62002-07-17 16:30:39 +00001371static void object_dealloc(PyObject *);
1372static int object_init(PyObject *, PyObject *, PyObject *);
1373static int update_slot(PyTypeObject *, PyObject *);
1374static void fixup_slot_dispatchers(PyTypeObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001375
1376static PyObject *
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001377subtype_dict(PyObject *obj, void *context)
1378{
1379 PyObject **dictptr = _PyObject_GetDictPtr(obj);
1380 PyObject *dict;
1381
1382 if (dictptr == NULL) {
1383 PyErr_SetString(PyExc_AttributeError,
1384 "This object has no __dict__");
1385 return NULL;
1386 }
1387 dict = *dictptr;
Guido van Rossum3926a632001-09-25 16:25:58 +00001388 if (dict == NULL)
1389 *dictptr = dict = PyDict_New();
1390 Py_XINCREF(dict);
1391 return dict;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001392}
1393
Guido van Rossum6661be32001-10-26 04:26:12 +00001394static int
1395subtype_setdict(PyObject *obj, PyObject *value, void *context)
1396{
1397 PyObject **dictptr = _PyObject_GetDictPtr(obj);
1398 PyObject *dict;
1399
1400 if (dictptr == NULL) {
1401 PyErr_SetString(PyExc_AttributeError,
1402 "This object has no __dict__");
1403 return -1;
1404 }
Guido van Rossumd331cb52001-12-05 19:46:42 +00001405 if (value != NULL && !PyDict_Check(value)) {
Guido van Rossum6661be32001-10-26 04:26:12 +00001406 PyErr_SetString(PyExc_TypeError,
1407 "__dict__ must be set to a dictionary");
1408 return -1;
1409 }
1410 dict = *dictptr;
Guido van Rossumd331cb52001-12-05 19:46:42 +00001411 Py_XINCREF(value);
Guido van Rossum6661be32001-10-26 04:26:12 +00001412 *dictptr = value;
1413 Py_XDECREF(dict);
1414 return 0;
1415}
1416
Guido van Rossumad47da02002-08-12 19:05:44 +00001417static PyObject *
1418subtype_getweakref(PyObject *obj, void *context)
1419{
1420 PyObject **weaklistptr;
1421 PyObject *result;
1422
1423 if (obj->ob_type->tp_weaklistoffset == 0) {
1424 PyErr_SetString(PyExc_AttributeError,
1425 "This object has no __weaklist__");
1426 return NULL;
1427 }
1428 assert(obj->ob_type->tp_weaklistoffset > 0);
1429 assert(obj->ob_type->tp_weaklistoffset + sizeof(PyObject *) <=
Guido van Rossum3747a0f2002-08-12 19:25:08 +00001430 (size_t)(obj->ob_type->tp_basicsize));
Guido van Rossumad47da02002-08-12 19:05:44 +00001431 weaklistptr = (PyObject **)
Guido van Rossum3747a0f2002-08-12 19:25:08 +00001432 ((char *)obj + obj->ob_type->tp_weaklistoffset);
Guido van Rossumad47da02002-08-12 19:05:44 +00001433 if (*weaklistptr == NULL)
1434 result = Py_None;
1435 else
1436 result = *weaklistptr;
1437 Py_INCREF(result);
1438 return result;
1439}
1440
Guido van Rossum373c7412003-01-07 13:41:37 +00001441/* Three variants on the subtype_getsets list. */
1442
1443static PyGetSetDef subtype_getsets_full[] = {
Guido van Rossumad47da02002-08-12 19:05:44 +00001444 {"__dict__", subtype_dict, subtype_setdict,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001445 PyDoc_STR("dictionary for instance variables (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001446 {"__weakref__", subtype_getweakref, NULL,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001447 PyDoc_STR("list of weak references to the object (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001448 {0}
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001449};
1450
Guido van Rossum373c7412003-01-07 13:41:37 +00001451static PyGetSetDef subtype_getsets_dict_only[] = {
1452 {"__dict__", subtype_dict, subtype_setdict,
1453 PyDoc_STR("dictionary for instance variables (if defined)")},
1454 {0}
1455};
1456
1457static PyGetSetDef subtype_getsets_weakref_only[] = {
1458 {"__weakref__", subtype_getweakref, NULL,
1459 PyDoc_STR("list of weak references to the object (if defined)")},
1460 {0}
1461};
1462
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001463static int
1464valid_identifier(PyObject *s)
1465{
Guido van Rossum03013a02002-07-16 14:30:28 +00001466 unsigned char *p;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001467 int i, n;
1468
1469 if (!PyString_Check(s)) {
1470 PyErr_SetString(PyExc_TypeError,
1471 "__slots__ must be strings");
1472 return 0;
1473 }
Guido van Rossum03013a02002-07-16 14:30:28 +00001474 p = (unsigned char *) PyString_AS_STRING(s);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001475 n = PyString_GET_SIZE(s);
1476 /* We must reject an empty name. As a hack, we bump the
1477 length to 1 so that the loop will balk on the trailing \0. */
1478 if (n == 0)
1479 n = 1;
1480 for (i = 0; i < n; i++, p++) {
1481 if (!(i == 0 ? isalpha(*p) : isalnum(*p)) && *p != '_') {
1482 PyErr_SetString(PyExc_TypeError,
1483 "__slots__ must be identifiers");
1484 return 0;
1485 }
1486 }
1487 return 1;
1488}
1489
Martin v. Löwisd919a592002-10-14 21:07:28 +00001490#ifdef Py_USING_UNICODE
1491/* Replace Unicode objects in slots. */
1492
1493static PyObject *
1494_unicode_to_string(PyObject *slots, int nslots)
1495{
1496 PyObject *tmp = slots;
1497 PyObject *o, *o1;
1498 int i;
1499 intintargfunc copy = slots->ob_type->tp_as_sequence->sq_slice;
1500 for (i = 0; i < nslots; i++) {
1501 if (PyUnicode_Check(o = PyTuple_GET_ITEM(tmp, i))) {
1502 if (tmp == slots) {
1503 tmp = copy(slots, 0, PyTuple_GET_SIZE(slots));
1504 if (tmp == NULL)
1505 return NULL;
1506 }
1507 o1 = _PyUnicode_AsDefaultEncodedString
1508 (o, NULL);
1509 if (o1 == NULL) {
1510 Py_DECREF(tmp);
1511 return 0;
1512 }
1513 Py_INCREF(o1);
1514 Py_DECREF(o);
1515 PyTuple_SET_ITEM(tmp, i, o1);
1516 }
1517 }
1518 return tmp;
1519}
1520#endif
1521
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001522static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001523type_new(PyTypeObject *metatype, PyObject *args, PyObject *kwds)
1524{
1525 PyObject *name, *bases, *dict;
1526 static char *kwlist[] = {"name", "bases", "dict", 0};
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001527 PyObject *slots, *tmp, *newslots;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001528 PyTypeObject *type, *base, *tmptype, *winner;
Guido van Rossume5c691a2003-03-07 15:13:17 +00001529 PyHeapTypeObject *et;
Guido van Rossum6f799372001-09-20 20:46:19 +00001530 PyMemberDef *mp;
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00001531 int i, nbases, nslots, slotoffset, add_dict, add_weak;
Guido van Rossumad47da02002-08-12 19:05:44 +00001532 int j, may_add_dict, may_add_weak;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001533
Tim Peters3abca122001-10-27 19:37:48 +00001534 assert(args != NULL && PyTuple_Check(args));
1535 assert(kwds == NULL || PyDict_Check(kwds));
1536
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001537 /* Special case: type(x) should return x->ob_type */
Tim Peters3abca122001-10-27 19:37:48 +00001538 {
1539 const int nargs = PyTuple_GET_SIZE(args);
1540 const int nkwds = kwds == NULL ? 0 : PyDict_Size(kwds);
1541
1542 if (PyType_CheckExact(metatype) && nargs == 1 && nkwds == 0) {
1543 PyObject *x = PyTuple_GET_ITEM(args, 0);
1544 Py_INCREF(x->ob_type);
1545 return (PyObject *) x->ob_type;
1546 }
1547
1548 /* SF bug 475327 -- if that didn't trigger, we need 3
1549 arguments. but PyArg_ParseTupleAndKeywords below may give
1550 a msg saying type() needs exactly 3. */
1551 if (nargs + nkwds != 3) {
1552 PyErr_SetString(PyExc_TypeError,
1553 "type() takes 1 or 3 arguments");
1554 return NULL;
1555 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001556 }
1557
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001558 /* Check arguments: (name, bases, dict) */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001559 if (!PyArg_ParseTupleAndKeywords(args, kwds, "SO!O!:type", kwlist,
1560 &name,
1561 &PyTuple_Type, &bases,
1562 &PyDict_Type, &dict))
1563 return NULL;
1564
1565 /* Determine the proper metatype to deal with this,
1566 and check for metatype conflicts while we're at it.
1567 Note that if some other metatype wins to contract,
1568 it's possible that its instances are not types. */
1569 nbases = PyTuple_GET_SIZE(bases);
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001570 winner = metatype;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001571 for (i = 0; i < nbases; i++) {
1572 tmp = PyTuple_GET_ITEM(bases, i);
1573 tmptype = tmp->ob_type;
Tim Petersa91e9642001-11-14 23:32:33 +00001574 if (tmptype == &PyClass_Type)
1575 continue; /* Special case classic classes */
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001576 if (PyType_IsSubtype(winner, tmptype))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001577 continue;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001578 if (PyType_IsSubtype(tmptype, winner)) {
1579 winner = tmptype;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001580 continue;
1581 }
1582 PyErr_SetString(PyExc_TypeError,
Guido van Rossum636688d2003-04-23 12:07:22 +00001583 "metaclass conflict: "
1584 "the metaclass of a derived class "
1585 "must be a (non-strict) subclass "
1586 "of the metaclasses of all its bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001587 return NULL;
1588 }
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001589 if (winner != metatype) {
1590 if (winner->tp_new != type_new) /* Pass it to the winner */
1591 return winner->tp_new(winner, args, kwds);
1592 metatype = winner;
1593 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001594
1595 /* Adjust for empty tuple bases */
1596 if (nbases == 0) {
1597 bases = Py_BuildValue("(O)", &PyBaseObject_Type);
1598 if (bases == NULL)
1599 return NULL;
1600 nbases = 1;
1601 }
1602 else
1603 Py_INCREF(bases);
1604
1605 /* XXX From here until type is allocated, "return NULL" leaks bases! */
1606
1607 /* Calculate best base, and check that all bases are type objects */
1608 base = best_base(bases);
1609 if (base == NULL)
1610 return NULL;
1611 if (!PyType_HasFeature(base, Py_TPFLAGS_BASETYPE)) {
1612 PyErr_Format(PyExc_TypeError,
1613 "type '%.100s' is not an acceptable base type",
1614 base->tp_name);
1615 return NULL;
1616 }
1617
Tim Peters6d6c1a32001-08-02 04:15:00 +00001618 /* Check for a __slots__ sequence variable in dict, and count it */
1619 slots = PyDict_GetItemString(dict, "__slots__");
1620 nslots = 0;
Guido van Rossum9676b222001-08-17 20:32:36 +00001621 add_dict = 0;
1622 add_weak = 0;
Guido van Rossumad47da02002-08-12 19:05:44 +00001623 may_add_dict = base->tp_dictoffset == 0;
1624 may_add_weak = base->tp_weaklistoffset == 0 && base->tp_itemsize == 0;
1625 if (slots == NULL) {
1626 if (may_add_dict) {
1627 add_dict++;
1628 }
1629 if (may_add_weak) {
1630 add_weak++;
1631 }
1632 }
1633 else {
1634 /* Have slots */
1635
Tim Peters6d6c1a32001-08-02 04:15:00 +00001636 /* Make it into a tuple */
1637 if (PyString_Check(slots))
1638 slots = Py_BuildValue("(O)", slots);
1639 else
1640 slots = PySequence_Tuple(slots);
1641 if (slots == NULL)
1642 return NULL;
Guido van Rossumad47da02002-08-12 19:05:44 +00001643 assert(PyTuple_Check(slots));
1644
1645 /* Are slots allowed? */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001646 nslots = PyTuple_GET_SIZE(slots);
Guido van Rossume5c691a2003-03-07 15:13:17 +00001647 if (nslots > 0 && base->tp_itemsize != 0 && !PyType_Check(base)) {
1648 /* for the special case of meta types, allow slots */
Guido van Rossumc4141872001-08-30 04:43:35 +00001649 PyErr_Format(PyExc_TypeError,
1650 "nonempty __slots__ "
1651 "not supported for subtype of '%s'",
1652 base->tp_name);
Guido van Rossumad47da02002-08-12 19:05:44 +00001653 bad_slots:
1654 Py_DECREF(slots);
Guido van Rossumc4141872001-08-30 04:43:35 +00001655 return NULL;
1656 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001657
Martin v. Löwisd919a592002-10-14 21:07:28 +00001658#ifdef Py_USING_UNICODE
1659 tmp = _unicode_to_string(slots, nslots);
Martin v. Löwis13b1a5c2002-10-14 21:11:34 +00001660 if (tmp != slots) {
1661 Py_DECREF(slots);
1662 slots = tmp;
1663 }
Martin v. Löwisd919a592002-10-14 21:07:28 +00001664 if (!tmp)
1665 return NULL;
1666#endif
Guido van Rossumad47da02002-08-12 19:05:44 +00001667 /* Check for valid slot names and two special cases */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001668 for (i = 0; i < nslots; i++) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001669 PyObject *tmp = PyTuple_GET_ITEM(slots, i);
1670 char *s;
1671 if (!valid_identifier(tmp))
1672 goto bad_slots;
1673 assert(PyString_Check(tmp));
1674 s = PyString_AS_STRING(tmp);
1675 if (strcmp(s, "__dict__") == 0) {
1676 if (!may_add_dict || add_dict) {
1677 PyErr_SetString(PyExc_TypeError,
1678 "__dict__ slot disallowed: "
1679 "we already got one");
1680 goto bad_slots;
1681 }
1682 add_dict++;
1683 }
1684 if (strcmp(s, "__weakref__") == 0) {
1685 if (!may_add_weak || add_weak) {
1686 PyErr_SetString(PyExc_TypeError,
1687 "__weakref__ slot disallowed: "
1688 "either we already got one, "
1689 "or __itemsize__ != 0");
1690 goto bad_slots;
1691 }
1692 add_weak++;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001693 }
1694 }
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001695
Guido van Rossumad47da02002-08-12 19:05:44 +00001696 /* Copy slots into yet another tuple, demangling names */
1697 newslots = PyTuple_New(nslots - add_dict - add_weak);
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001698 if (newslots == NULL)
Guido van Rossumad47da02002-08-12 19:05:44 +00001699 goto bad_slots;
1700 for (i = j = 0; i < nslots; i++) {
1701 char *s;
Guido van Rossum8e829202002-08-16 03:47:49 +00001702 char buffer[256];
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001703 tmp = PyTuple_GET_ITEM(slots, i);
Guido van Rossumad47da02002-08-12 19:05:44 +00001704 s = PyString_AS_STRING(tmp);
1705 if ((add_dict && strcmp(s, "__dict__") == 0) ||
1706 (add_weak && strcmp(s, "__weakref__") == 0))
1707 continue;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001708 if (_Py_Mangle(PyString_AS_STRING(name),
Guido van Rossumad47da02002-08-12 19:05:44 +00001709 PyString_AS_STRING(tmp),
1710 buffer, sizeof(buffer)))
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001711 {
1712 tmp = PyString_FromString(buffer);
1713 } else {
1714 Py_INCREF(tmp);
1715 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001716 PyTuple_SET_ITEM(newslots, j, tmp);
1717 j++;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001718 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001719 assert(j == nslots - add_dict - add_weak);
1720 nslots = j;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001721 Py_DECREF(slots);
1722 slots = newslots;
1723
Guido van Rossumad47da02002-08-12 19:05:44 +00001724 /* Secondary bases may provide weakrefs or dict */
1725 if (nbases > 1 &&
1726 ((may_add_dict && !add_dict) ||
1727 (may_add_weak && !add_weak))) {
1728 for (i = 0; i < nbases; i++) {
1729 tmp = PyTuple_GET_ITEM(bases, i);
1730 if (tmp == (PyObject *)base)
1731 continue; /* Skip primary base */
1732 if (PyClass_Check(tmp)) {
1733 /* Classic base class provides both */
1734 if (may_add_dict && !add_dict)
1735 add_dict++;
1736 if (may_add_weak && !add_weak)
1737 add_weak++;
1738 break;
1739 }
1740 assert(PyType_Check(tmp));
1741 tmptype = (PyTypeObject *)tmp;
1742 if (may_add_dict && !add_dict &&
1743 tmptype->tp_dictoffset != 0)
1744 add_dict++;
1745 if (may_add_weak && !add_weak &&
1746 tmptype->tp_weaklistoffset != 0)
1747 add_weak++;
1748 if (may_add_dict && !add_dict)
1749 continue;
1750 if (may_add_weak && !add_weak)
1751 continue;
1752 /* Nothing more to check */
1753 break;
1754 }
1755 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001756 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001757
1758 /* XXX From here until type is safely allocated,
1759 "return NULL" may leak slots! */
1760
1761 /* Allocate the type object */
1762 type = (PyTypeObject *)metatype->tp_alloc(metatype, nslots);
Guido van Rossumad47da02002-08-12 19:05:44 +00001763 if (type == NULL) {
1764 Py_XDECREF(slots);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001765 return NULL;
Guido van Rossumad47da02002-08-12 19:05:44 +00001766 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001767
1768 /* Keep name and slots alive in the extended type object */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001769 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001770 Py_INCREF(name);
1771 et->name = name;
1772 et->slots = slots;
1773
Guido van Rossumdc91b992001-08-08 22:26:22 +00001774 /* Initialize tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001775 type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE |
1776 Py_TPFLAGS_BASETYPE;
Guido van Rossum048eb752001-10-02 21:24:57 +00001777 if (base->tp_flags & Py_TPFLAGS_HAVE_GC)
1778 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossumdc91b992001-08-08 22:26:22 +00001779
1780 /* It's a new-style number unless it specifically inherits any
1781 old-style numeric behavior */
1782 if ((base->tp_flags & Py_TPFLAGS_CHECKTYPES) ||
1783 (base->tp_as_number == NULL))
1784 type->tp_flags |= Py_TPFLAGS_CHECKTYPES;
1785
1786 /* Initialize essential fields */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001787 type->tp_as_number = &et->as_number;
1788 type->tp_as_sequence = &et->as_sequence;
1789 type->tp_as_mapping = &et->as_mapping;
1790 type->tp_as_buffer = &et->as_buffer;
1791 type->tp_name = PyString_AS_STRING(name);
1792
1793 /* Set tp_base and tp_bases */
1794 type->tp_bases = bases;
1795 Py_INCREF(base);
1796 type->tp_base = base;
1797
Guido van Rossum687ae002001-10-15 22:03:32 +00001798 /* Initialize tp_dict from passed-in dict */
1799 type->tp_dict = dict = PyDict_Copy(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001800 if (dict == NULL) {
1801 Py_DECREF(type);
1802 return NULL;
1803 }
1804
Guido van Rossumc3542212001-08-16 09:18:56 +00001805 /* Set __module__ in the dict */
1806 if (PyDict_GetItemString(dict, "__module__") == NULL) {
1807 tmp = PyEval_GetGlobals();
1808 if (tmp != NULL) {
1809 tmp = PyDict_GetItemString(tmp, "__name__");
1810 if (tmp != NULL) {
1811 if (PyDict_SetItemString(dict, "__module__",
1812 tmp) < 0)
1813 return NULL;
1814 }
1815 }
1816 }
1817
Tim Peters2f93e282001-10-04 05:27:00 +00001818 /* Set tp_doc to a copy of dict['__doc__'], if the latter is there
Tim Peters24008312002-03-17 18:56:20 +00001819 and is a string. The __doc__ accessor will first look for tp_doc;
1820 if that fails, it will still look into __dict__.
Tim Peters2f93e282001-10-04 05:27:00 +00001821 */
1822 {
1823 PyObject *doc = PyDict_GetItemString(dict, "__doc__");
1824 if (doc != NULL && PyString_Check(doc)) {
1825 const size_t n = (size_t)PyString_GET_SIZE(doc);
Tim Peters59f809d2001-10-04 05:43:02 +00001826 type->tp_doc = (char *)PyObject_MALLOC(n+1);
Tim Peters2f93e282001-10-04 05:27:00 +00001827 if (type->tp_doc == NULL) {
1828 Py_DECREF(type);
1829 return NULL;
1830 }
1831 memcpy(type->tp_doc, PyString_AS_STRING(doc), n+1);
1832 }
1833 }
1834
Tim Peters6d6c1a32001-08-02 04:15:00 +00001835 /* Special-case __new__: if it's a plain function,
1836 make it a static function */
1837 tmp = PyDict_GetItemString(dict, "__new__");
1838 if (tmp != NULL && PyFunction_Check(tmp)) {
1839 tmp = PyStaticMethod_New(tmp);
1840 if (tmp == NULL) {
1841 Py_DECREF(type);
1842 return NULL;
1843 }
1844 PyDict_SetItemString(dict, "__new__", tmp);
1845 Py_DECREF(tmp);
1846 }
1847
1848 /* Add descriptors for custom slots from __slots__, or for __dict__ */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001849 mp = PyHeapType_GET_MEMBERS(et);
Neil Schemenauerc806c882001-08-29 23:54:54 +00001850 slotoffset = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001851 if (slots != NULL) {
1852 for (i = 0; i < nslots; i++, mp++) {
1853 mp->name = PyString_AS_STRING(
1854 PyTuple_GET_ITEM(slots, i));
Guido van Rossum64b206c2001-12-04 17:13:22 +00001855 mp->type = T_OBJECT_EX;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001856 mp->offset = slotoffset;
Guido van Rossum9676b222001-08-17 20:32:36 +00001857 if (base->tp_weaklistoffset == 0 &&
Guido van Rossum64b206c2001-12-04 17:13:22 +00001858 strcmp(mp->name, "__weakref__") == 0) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001859 add_weak++;
Guido van Rossum64b206c2001-12-04 17:13:22 +00001860 mp->type = T_OBJECT;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001861 mp->flags = READONLY;
Guido van Rossum9676b222001-08-17 20:32:36 +00001862 type->tp_weaklistoffset = slotoffset;
Guido van Rossum64b206c2001-12-04 17:13:22 +00001863 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001864 slotoffset += sizeof(PyObject *);
1865 }
1866 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001867 if (add_dict) {
1868 if (base->tp_itemsize)
1869 type->tp_dictoffset = -(long)sizeof(PyObject *);
1870 else
1871 type->tp_dictoffset = slotoffset;
1872 slotoffset += sizeof(PyObject *);
1873 }
1874 if (add_weak) {
1875 assert(!base->tp_itemsize);
1876 type->tp_weaklistoffset = slotoffset;
1877 slotoffset += sizeof(PyObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001878 }
1879 type->tp_basicsize = slotoffset;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001880 type->tp_itemsize = base->tp_itemsize;
Guido van Rossume5c691a2003-03-07 15:13:17 +00001881 type->tp_members = PyHeapType_GET_MEMBERS(et);
Guido van Rossum373c7412003-01-07 13:41:37 +00001882
1883 if (type->tp_weaklistoffset && type->tp_dictoffset)
1884 type->tp_getset = subtype_getsets_full;
1885 else if (type->tp_weaklistoffset && !type->tp_dictoffset)
1886 type->tp_getset = subtype_getsets_weakref_only;
1887 else if (!type->tp_weaklistoffset && type->tp_dictoffset)
1888 type->tp_getset = subtype_getsets_dict_only;
1889 else
1890 type->tp_getset = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001891
1892 /* Special case some slots */
1893 if (type->tp_dictoffset != 0 || nslots > 0) {
1894 if (base->tp_getattr == NULL && base->tp_getattro == NULL)
1895 type->tp_getattro = PyObject_GenericGetAttr;
1896 if (base->tp_setattr == NULL && base->tp_setattro == NULL)
1897 type->tp_setattro = PyObject_GenericSetAttr;
1898 }
1899 type->tp_dealloc = subtype_dealloc;
1900
Guido van Rossum9475a232001-10-05 20:51:39 +00001901 /* Enable GC unless there are really no instance variables possible */
1902 if (!(type->tp_basicsize == sizeof(PyObject) &&
1903 type->tp_itemsize == 0))
1904 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
1905
Tim Peters6d6c1a32001-08-02 04:15:00 +00001906 /* Always override allocation strategy to use regular heap */
1907 type->tp_alloc = PyType_GenericAlloc;
Guido van Rossum048eb752001-10-02 21:24:57 +00001908 if (type->tp_flags & Py_TPFLAGS_HAVE_GC) {
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001909 type->tp_free = PyObject_GC_Del;
Guido van Rossum9475a232001-10-05 20:51:39 +00001910 type->tp_traverse = subtype_traverse;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001911 type->tp_clear = subtype_clear;
Guido van Rossum048eb752001-10-02 21:24:57 +00001912 }
1913 else
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001914 type->tp_free = PyObject_Del;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001915
1916 /* Initialize the rest */
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001917 if (PyType_Ready(type) < 0) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001918 Py_DECREF(type);
1919 return NULL;
1920 }
1921
Guido van Rossum7b9144b2001-10-09 19:39:46 +00001922 /* Put the proper slots in place */
1923 fixup_slot_dispatchers(type);
Guido van Rossumf040ede2001-08-07 16:40:56 +00001924
Tim Peters6d6c1a32001-08-02 04:15:00 +00001925 return (PyObject *)type;
1926}
1927
1928/* Internal API to look for a name through the MRO.
1929 This returns a borrowed reference, and doesn't set an exception! */
1930PyObject *
1931_PyType_Lookup(PyTypeObject *type, PyObject *name)
1932{
1933 int i, n;
Tim Petersa91e9642001-11-14 23:32:33 +00001934 PyObject *mro, *res, *base, *dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001935
Guido van Rossum687ae002001-10-15 22:03:32 +00001936 /* Look in tp_dict of types in MRO */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001937 mro = type->tp_mro;
Guido van Rossum23094982002-06-10 14:30:43 +00001938
1939 /* If mro is NULL, the type is either not yet initialized
1940 by PyType_Ready(), or already cleared by type_clear().
1941 Either way the safest thing to do is to return NULL. */
1942 if (mro == NULL)
1943 return NULL;
1944
Tim Peters6d6c1a32001-08-02 04:15:00 +00001945 assert(PyTuple_Check(mro));
1946 n = PyTuple_GET_SIZE(mro);
1947 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001948 base = PyTuple_GET_ITEM(mro, i);
1949 if (PyClass_Check(base))
1950 dict = ((PyClassObject *)base)->cl_dict;
1951 else {
1952 assert(PyType_Check(base));
1953 dict = ((PyTypeObject *)base)->tp_dict;
1954 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001955 assert(dict && PyDict_Check(dict));
1956 res = PyDict_GetItem(dict, name);
1957 if (res != NULL)
1958 return res;
1959 }
1960 return NULL;
1961}
1962
1963/* This is similar to PyObject_GenericGetAttr(),
1964 but uses _PyType_Lookup() instead of just looking in type->tp_dict. */
1965static PyObject *
1966type_getattro(PyTypeObject *type, PyObject *name)
1967{
1968 PyTypeObject *metatype = type->ob_type;
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001969 PyObject *meta_attribute, *attribute;
1970 descrgetfunc meta_get;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001971
1972 /* Initialize this type (we'll assume the metatype is initialized) */
1973 if (type->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001974 if (PyType_Ready(type) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001975 return NULL;
1976 }
1977
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001978 /* No readable descriptor found yet */
1979 meta_get = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001980
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001981 /* Look for the attribute in the metatype */
1982 meta_attribute = _PyType_Lookup(metatype, name);
1983
1984 if (meta_attribute != NULL) {
1985 meta_get = meta_attribute->ob_type->tp_descr_get;
Tim Peters34592512002-07-11 06:23:50 +00001986
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001987 if (meta_get != NULL && PyDescr_IsData(meta_attribute)) {
1988 /* Data descriptors implement tp_descr_set to intercept
1989 * writes. Assume the attribute is not overridden in
1990 * type's tp_dict (and bases): call the descriptor now.
1991 */
1992 return meta_get(meta_attribute, (PyObject *)type,
1993 (PyObject *)metatype);
1994 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001995 }
1996
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001997 /* No data descriptor found on metatype. Look in tp_dict of this
1998 * type and its bases */
1999 attribute = _PyType_Lookup(type, name);
2000 if (attribute != NULL) {
2001 /* Implement descriptor functionality, if any */
2002 descrgetfunc local_get = attribute->ob_type->tp_descr_get;
2003 if (local_get != NULL) {
2004 /* NULL 2nd argument indicates the descriptor was
2005 * found on the target object itself (or a base) */
2006 return local_get(attribute, (PyObject *)NULL,
2007 (PyObject *)type);
2008 }
Tim Peters34592512002-07-11 06:23:50 +00002009
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002010 Py_INCREF(attribute);
2011 return attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002012 }
2013
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002014 /* No attribute found in local __dict__ (or bases): use the
2015 * descriptor from the metatype, if any */
2016 if (meta_get != NULL)
2017 return meta_get(meta_attribute, (PyObject *)type,
2018 (PyObject *)metatype);
2019
2020 /* If an ordinary attribute was found on the metatype, return it now */
2021 if (meta_attribute != NULL) {
2022 Py_INCREF(meta_attribute);
2023 return meta_attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002024 }
2025
2026 /* Give up */
2027 PyErr_Format(PyExc_AttributeError,
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002028 "type object '%.50s' has no attribute '%.400s'",
2029 type->tp_name, PyString_AS_STRING(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +00002030 return NULL;
2031}
2032
2033static int
2034type_setattro(PyTypeObject *type, PyObject *name, PyObject *value)
2035{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002036 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2037 PyErr_Format(
2038 PyExc_TypeError,
2039 "can't set attributes of built-in/extension type '%s'",
2040 type->tp_name);
2041 return -1;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002042 }
Guido van Rossum8d24ee92003-03-24 23:49:49 +00002043 /* XXX Example of how I expect this to be used...
2044 if (update_subclasses(type, name, invalidate_cache, NULL) < 0)
2045 return -1;
2046 */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002047 if (PyObject_GenericSetAttr((PyObject *)type, name, value) < 0)
2048 return -1;
2049 return update_slot(type, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002050}
2051
2052static void
2053type_dealloc(PyTypeObject *type)
2054{
Guido van Rossume5c691a2003-03-07 15:13:17 +00002055 PyHeapTypeObject *et;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002056
2057 /* Assert this is a heap-allocated type object */
2058 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002059 _PyObject_GC_UNTRACK(type);
Guido van Rossum1c450732001-10-08 15:18:27 +00002060 PyObject_ClearWeakRefs((PyObject *)type);
Guido van Rossume5c691a2003-03-07 15:13:17 +00002061 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002062 Py_XDECREF(type->tp_base);
2063 Py_XDECREF(type->tp_dict);
2064 Py_XDECREF(type->tp_bases);
2065 Py_XDECREF(type->tp_mro);
Guido van Rossum687ae002001-10-15 22:03:32 +00002066 Py_XDECREF(type->tp_cache);
Guido van Rossum1c450732001-10-08 15:18:27 +00002067 Py_XDECREF(type->tp_subclasses);
Neal Norwitzcee5ca02002-07-30 00:42:06 +00002068 PyObject_Free(type->tp_doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002069 Py_XDECREF(et->name);
2070 Py_XDECREF(et->slots);
2071 type->ob_type->tp_free((PyObject *)type);
2072}
2073
Guido van Rossum1c450732001-10-08 15:18:27 +00002074static PyObject *
2075type_subclasses(PyTypeObject *type, PyObject *args_ignored)
2076{
2077 PyObject *list, *raw, *ref;
2078 int i, n;
2079
2080 list = PyList_New(0);
2081 if (list == NULL)
2082 return NULL;
2083 raw = type->tp_subclasses;
2084 if (raw == NULL)
2085 return list;
2086 assert(PyList_Check(raw));
2087 n = PyList_GET_SIZE(raw);
2088 for (i = 0; i < n; i++) {
2089 ref = PyList_GET_ITEM(raw, i);
Tim Peters44383382001-10-08 16:49:26 +00002090 assert(PyWeakref_CheckRef(ref));
Guido van Rossum1c450732001-10-08 15:18:27 +00002091 ref = PyWeakref_GET_OBJECT(ref);
2092 if (ref != Py_None) {
2093 if (PyList_Append(list, ref) < 0) {
2094 Py_DECREF(list);
2095 return NULL;
2096 }
2097 }
2098 }
2099 return list;
2100}
2101
Tim Peters6d6c1a32001-08-02 04:15:00 +00002102static PyMethodDef type_methods[] = {
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002103 {"mro", (PyCFunction)mro_external, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002104 PyDoc_STR("mro() -> list\nreturn a type's method resolution order")},
Guido van Rossum1c450732001-10-08 15:18:27 +00002105 {"__subclasses__", (PyCFunction)type_subclasses, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002106 PyDoc_STR("__subclasses__() -> list of immediate subclasses")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002107 {0}
2108};
2109
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002110PyDoc_STRVAR(type_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002111"type(object) -> the object's type\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002112"type(name, bases, dict) -> a new type");
Tim Peters6d6c1a32001-08-02 04:15:00 +00002113
Guido van Rossum048eb752001-10-02 21:24:57 +00002114static int
2115type_traverse(PyTypeObject *type, visitproc visit, void *arg)
2116{
Guido van Rossum048eb752001-10-02 21:24:57 +00002117 int err;
2118
Guido van Rossuma3862092002-06-10 15:24:42 +00002119 /* Because of type_is_gc(), the collector only calls this
2120 for heaptypes. */
2121 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002122
2123#define VISIT(SLOT) \
2124 if (SLOT) { \
2125 err = visit((PyObject *)(SLOT), arg); \
2126 if (err) \
2127 return err; \
2128 }
2129
2130 VISIT(type->tp_dict);
Guido van Rossum687ae002001-10-15 22:03:32 +00002131 VISIT(type->tp_cache);
Guido van Rossum048eb752001-10-02 21:24:57 +00002132 VISIT(type->tp_mro);
2133 VISIT(type->tp_bases);
2134 VISIT(type->tp_base);
Guido van Rossuma3862092002-06-10 15:24:42 +00002135
2136 /* There's no need to visit type->tp_subclasses or
Guido van Rossume5c691a2003-03-07 15:13:17 +00002137 ((PyHeapTypeObject *)type)->slots, because they can't be involved
Guido van Rossuma3862092002-06-10 15:24:42 +00002138 in cycles; tp_subclasses is a list of weak references,
2139 and slots is a tuple of strings. */
Guido van Rossum048eb752001-10-02 21:24:57 +00002140
2141#undef VISIT
2142
2143 return 0;
2144}
2145
2146static int
2147type_clear(PyTypeObject *type)
2148{
Guido van Rossum048eb752001-10-02 21:24:57 +00002149 PyObject *tmp;
2150
Guido van Rossuma3862092002-06-10 15:24:42 +00002151 /* Because of type_is_gc(), the collector only calls this
2152 for heaptypes. */
2153 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002154
2155#define CLEAR(SLOT) \
2156 if (SLOT) { \
2157 tmp = (PyObject *)(SLOT); \
2158 SLOT = NULL; \
2159 Py_DECREF(tmp); \
2160 }
2161
Guido van Rossuma3862092002-06-10 15:24:42 +00002162 /* The only field we need to clear is tp_mro, which is part of a
2163 hard cycle (its first element is the class itself) that won't
2164 be broken otherwise (it's a tuple and tuples don't have a
2165 tp_clear handler). None of the other fields need to be
2166 cleared, and here's why:
Guido van Rossum048eb752001-10-02 21:24:57 +00002167
Guido van Rossuma3862092002-06-10 15:24:42 +00002168 tp_dict:
2169 It is a dict, so the collector will call its tp_clear.
2170
2171 tp_cache:
2172 Not used; if it were, it would be a dict.
2173
2174 tp_bases, tp_base:
2175 If these are involved in a cycle, there must be at least
2176 one other, mutable object in the cycle, e.g. a base
2177 class's dict; the cycle will be broken that way.
2178
2179 tp_subclasses:
2180 A list of weak references can't be part of a cycle; and
2181 lists have their own tp_clear.
2182
Guido van Rossume5c691a2003-03-07 15:13:17 +00002183 slots (in PyHeapTypeObject):
Guido van Rossuma3862092002-06-10 15:24:42 +00002184 A tuple of strings can't be part of a cycle.
2185 */
2186
2187 CLEAR(type->tp_mro);
Tim Peters2f93e282001-10-04 05:27:00 +00002188
Guido van Rossum048eb752001-10-02 21:24:57 +00002189#undef CLEAR
2190
2191 return 0;
2192}
2193
2194static int
2195type_is_gc(PyTypeObject *type)
2196{
2197 return type->tp_flags & Py_TPFLAGS_HEAPTYPE;
2198}
2199
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002200PyTypeObject PyType_Type = {
2201 PyObject_HEAD_INIT(&PyType_Type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002202 0, /* ob_size */
2203 "type", /* tp_name */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002204 sizeof(PyHeapTypeObject), /* tp_basicsize */
Guido van Rossum6f799372001-09-20 20:46:19 +00002205 sizeof(PyMemberDef), /* tp_itemsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002206 (destructor)type_dealloc, /* tp_dealloc */
2207 0, /* tp_print */
2208 0, /* tp_getattr */
2209 0, /* tp_setattr */
2210 type_compare, /* tp_compare */
2211 (reprfunc)type_repr, /* tp_repr */
2212 0, /* tp_as_number */
2213 0, /* tp_as_sequence */
2214 0, /* tp_as_mapping */
2215 (hashfunc)_Py_HashPointer, /* tp_hash */
2216 (ternaryfunc)type_call, /* tp_call */
2217 0, /* tp_str */
2218 (getattrofunc)type_getattro, /* tp_getattro */
2219 (setattrofunc)type_setattro, /* tp_setattro */
2220 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00002221 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
2222 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002223 type_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00002224 (traverseproc)type_traverse, /* tp_traverse */
2225 (inquiry)type_clear, /* tp_clear */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002226 0, /* tp_richcompare */
Guido van Rossum1c450732001-10-08 15:18:27 +00002227 offsetof(PyTypeObject, tp_weaklist), /* tp_weaklistoffset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002228 0, /* tp_iter */
2229 0, /* tp_iternext */
2230 type_methods, /* tp_methods */
2231 type_members, /* tp_members */
2232 type_getsets, /* tp_getset */
2233 0, /* tp_base */
2234 0, /* tp_dict */
2235 0, /* tp_descr_get */
2236 0, /* tp_descr_set */
2237 offsetof(PyTypeObject, tp_dict), /* tp_dictoffset */
2238 0, /* tp_init */
2239 0, /* tp_alloc */
2240 type_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002241 PyObject_GC_Del, /* tp_free */
Guido van Rossum048eb752001-10-02 21:24:57 +00002242 (inquiry)type_is_gc, /* tp_is_gc */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002243};
Tim Peters6d6c1a32001-08-02 04:15:00 +00002244
2245
2246/* The base type of all types (eventually)... except itself. */
2247
2248static int
2249object_init(PyObject *self, PyObject *args, PyObject *kwds)
2250{
2251 return 0;
2252}
2253
Guido van Rossum298e4212003-02-13 16:30:16 +00002254/* If we don't have a tp_new for a new-style class, new will use this one.
2255 Therefore this should take no arguments/keywords. However, this new may
2256 also be inherited by objects that define a tp_init but no tp_new. These
2257 objects WILL pass argumets to tp_new, because it gets the same args as
2258 tp_init. So only allow arguments if we aren't using the default init, in
2259 which case we expect init to handle argument parsing. */
2260static PyObject *
2261object_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2262{
2263 if (type->tp_init == object_init && (PyTuple_GET_SIZE(args) ||
2264 (kwds && PyDict_Check(kwds) && PyDict_Size(kwds)))) {
2265 PyErr_SetString(PyExc_TypeError,
2266 "default __new__ takes no parameters");
2267 return NULL;
2268 }
2269 return type->tp_alloc(type, 0);
2270}
2271
Tim Peters6d6c1a32001-08-02 04:15:00 +00002272static void
2273object_dealloc(PyObject *self)
2274{
2275 self->ob_type->tp_free(self);
2276}
2277
Guido van Rossum8e248182001-08-12 05:17:56 +00002278static PyObject *
2279object_repr(PyObject *self)
2280{
Guido van Rossum76e69632001-08-16 18:52:43 +00002281 PyTypeObject *type;
Barry Warsaw7ce36942001-08-24 18:34:26 +00002282 PyObject *mod, *name, *rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002283
Guido van Rossum76e69632001-08-16 18:52:43 +00002284 type = self->ob_type;
2285 mod = type_module(type, NULL);
2286 if (mod == NULL)
2287 PyErr_Clear();
2288 else if (!PyString_Check(mod)) {
2289 Py_DECREF(mod);
2290 mod = NULL;
2291 }
2292 name = type_name(type, NULL);
2293 if (name == NULL)
2294 return NULL;
2295 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__"))
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002296 rtn = PyString_FromFormat("<%s.%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002297 PyString_AS_STRING(mod),
2298 PyString_AS_STRING(name),
2299 self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002300 else
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002301 rtn = PyString_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002302 type->tp_name, self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002303 Py_XDECREF(mod);
2304 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +00002305 return rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002306}
2307
Guido van Rossumb8f63662001-08-15 23:57:02 +00002308static PyObject *
2309object_str(PyObject *self)
2310{
2311 unaryfunc f;
2312
2313 f = self->ob_type->tp_repr;
2314 if (f == NULL)
2315 f = object_repr;
2316 return f(self);
2317}
2318
Guido van Rossum8e248182001-08-12 05:17:56 +00002319static long
2320object_hash(PyObject *self)
2321{
2322 return _Py_HashPointer(self);
2323}
Guido van Rossum8e248182001-08-12 05:17:56 +00002324
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002325static PyObject *
2326object_get_class(PyObject *self, void *closure)
2327{
2328 Py_INCREF(self->ob_type);
2329 return (PyObject *)(self->ob_type);
2330}
2331
2332static int
2333equiv_structs(PyTypeObject *a, PyTypeObject *b)
2334{
2335 return a == b ||
2336 (a != NULL &&
2337 b != NULL &&
2338 a->tp_basicsize == b->tp_basicsize &&
2339 a->tp_itemsize == b->tp_itemsize &&
2340 a->tp_dictoffset == b->tp_dictoffset &&
2341 a->tp_weaklistoffset == b->tp_weaklistoffset &&
2342 ((a->tp_flags & Py_TPFLAGS_HAVE_GC) ==
2343 (b->tp_flags & Py_TPFLAGS_HAVE_GC)));
2344}
2345
2346static int
2347same_slots_added(PyTypeObject *a, PyTypeObject *b)
2348{
2349 PyTypeObject *base = a->tp_base;
2350 int size;
2351
2352 if (base != b->tp_base)
2353 return 0;
2354 if (equiv_structs(a, base) && equiv_structs(b, base))
2355 return 1;
2356 size = base->tp_basicsize;
2357 if (a->tp_dictoffset == size && b->tp_dictoffset == size)
2358 size += sizeof(PyObject *);
2359 if (a->tp_weaklistoffset == size && b->tp_weaklistoffset == size)
2360 size += sizeof(PyObject *);
2361 return size == a->tp_basicsize && size == b->tp_basicsize;
2362}
2363
2364static int
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002365compatible_for_assignment(PyTypeObject* old, PyTypeObject* new, char* attr)
2366{
2367 PyTypeObject *newbase, *oldbase;
2368
2369 if (new->tp_dealloc != old->tp_dealloc ||
2370 new->tp_free != old->tp_free)
2371 {
2372 PyErr_Format(PyExc_TypeError,
2373 "%s assignment: "
2374 "'%s' deallocator differs from '%s'",
2375 attr,
2376 new->tp_name,
2377 old->tp_name);
2378 return 0;
2379 }
2380 newbase = new;
2381 oldbase = old;
2382 while (equiv_structs(newbase, newbase->tp_base))
2383 newbase = newbase->tp_base;
2384 while (equiv_structs(oldbase, oldbase->tp_base))
2385 oldbase = oldbase->tp_base;
2386 if (newbase != oldbase &&
2387 (newbase->tp_base != oldbase->tp_base ||
2388 !same_slots_added(newbase, oldbase))) {
2389 PyErr_Format(PyExc_TypeError,
2390 "%s assignment: "
2391 "'%s' object layout differs from '%s'",
2392 attr,
2393 new->tp_name,
2394 old->tp_name);
2395 return 0;
2396 }
Tim Petersea7f75d2002-12-07 21:39:16 +00002397
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002398 return 1;
2399}
2400
2401static int
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002402object_set_class(PyObject *self, PyObject *value, void *closure)
2403{
2404 PyTypeObject *old = self->ob_type;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002405 PyTypeObject *new;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002406
Guido van Rossumb6b89422002-04-15 01:03:30 +00002407 if (value == NULL) {
2408 PyErr_SetString(PyExc_TypeError,
2409 "can't delete __class__ attribute");
2410 return -1;
2411 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002412 if (!PyType_Check(value)) {
2413 PyErr_Format(PyExc_TypeError,
2414 "__class__ must be set to new-style class, not '%s' object",
2415 value->ob_type->tp_name);
2416 return -1;
2417 }
2418 new = (PyTypeObject *)value;
Guido van Rossum40af8892002-08-10 05:42:07 +00002419 if (!(new->tp_flags & Py_TPFLAGS_HEAPTYPE) ||
2420 !(old->tp_flags & Py_TPFLAGS_HEAPTYPE))
2421 {
2422 PyErr_Format(PyExc_TypeError,
2423 "__class__ assignment: only for heap types");
2424 return -1;
2425 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002426 if (compatible_for_assignment(new, old, "__class__")) {
2427 Py_INCREF(new);
2428 self->ob_type = new;
2429 Py_DECREF(old);
2430 return 0;
2431 }
2432 else {
Guido van Rossum9ee4b942002-05-24 18:47:47 +00002433 return -1;
2434 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002435}
2436
2437static PyGetSetDef object_getsets[] = {
2438 {"__class__", object_get_class, object_set_class,
Neal Norwitz858e34f2002-08-13 17:18:45 +00002439 PyDoc_STR("the object's class")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002440 {0}
2441};
2442
Guido van Rossumc53f0092003-02-18 22:05:12 +00002443
Guido van Rossum036f9992003-02-21 22:02:54 +00002444/* Stuff to implement __reduce_ex__ for pickle protocols >= 2.
2445 We fall back to helpers in copy_reg for:
2446 - pickle protocols < 2
2447 - calculating the list of slot names (done only once per class)
2448 - the __newobj__ function (which is used as a token but never called)
2449*/
2450
2451static PyObject *
2452import_copy_reg(void)
2453{
2454 static PyObject *copy_reg_str;
Guido van Rossum3926a632001-09-25 16:25:58 +00002455
2456 if (!copy_reg_str) {
2457 copy_reg_str = PyString_InternFromString("copy_reg");
2458 if (copy_reg_str == NULL)
2459 return NULL;
2460 }
Guido van Rossum036f9992003-02-21 22:02:54 +00002461
2462 return PyImport_Import(copy_reg_str);
2463}
2464
2465static PyObject *
2466slotnames(PyObject *cls)
2467{
2468 PyObject *clsdict;
2469 PyObject *copy_reg;
2470 PyObject *slotnames;
2471
2472 if (!PyType_Check(cls)) {
2473 Py_INCREF(Py_None);
2474 return Py_None;
2475 }
2476
2477 clsdict = ((PyTypeObject *)cls)->tp_dict;
2478 slotnames = PyDict_GetItemString(clsdict, "__slotnames__");
2479 if (slotnames != NULL) {
2480 Py_INCREF(slotnames);
2481 return slotnames;
2482 }
2483
2484 copy_reg = import_copy_reg();
2485 if (copy_reg == NULL)
2486 return NULL;
2487
2488 slotnames = PyObject_CallMethod(copy_reg, "_slotnames", "O", cls);
2489 Py_DECREF(copy_reg);
2490 if (slotnames != NULL &&
2491 slotnames != Py_None &&
2492 !PyList_Check(slotnames))
2493 {
2494 PyErr_SetString(PyExc_TypeError,
2495 "copy_reg._slotnames didn't return a list or None");
2496 Py_DECREF(slotnames);
2497 slotnames = NULL;
2498 }
2499
2500 return slotnames;
2501}
2502
2503static PyObject *
2504reduce_2(PyObject *obj)
2505{
2506 PyObject *cls, *getnewargs;
2507 PyObject *args = NULL, *args2 = NULL;
2508 PyObject *getstate = NULL, *state = NULL, *names = NULL;
2509 PyObject *slots = NULL, *listitems = NULL, *dictitems = NULL;
2510 PyObject *copy_reg = NULL, *newobj = NULL, *res = NULL;
2511 int i, n;
2512
2513 cls = PyObject_GetAttrString(obj, "__class__");
2514 if (cls == NULL)
2515 return NULL;
2516
2517 getnewargs = PyObject_GetAttrString(obj, "__getnewargs__");
2518 if (getnewargs != NULL) {
2519 args = PyObject_CallObject(getnewargs, NULL);
2520 Py_DECREF(getnewargs);
2521 if (args != NULL && !PyTuple_Check(args)) {
2522 PyErr_SetString(PyExc_TypeError,
2523 "__getnewargs__ should return a tuple");
2524 goto end;
2525 }
2526 }
2527 else {
2528 PyErr_Clear();
2529 args = PyTuple_New(0);
2530 }
2531 if (args == NULL)
2532 goto end;
2533
2534 getstate = PyObject_GetAttrString(obj, "__getstate__");
2535 if (getstate != NULL) {
2536 state = PyObject_CallObject(getstate, NULL);
2537 Py_DECREF(getstate);
2538 }
2539 else {
2540 state = PyObject_GetAttrString(obj, "__dict__");
2541 if (state == NULL) {
2542 PyErr_Clear();
2543 state = Py_None;
2544 Py_INCREF(state);
2545 }
2546 names = slotnames(cls);
2547 if (names == NULL)
2548 goto end;
2549 if (names != Py_None) {
2550 assert(PyList_Check(names));
2551 slots = PyDict_New();
2552 if (slots == NULL)
2553 goto end;
2554 n = 0;
2555 /* Can't pre-compute the list size; the list
2556 is stored on the class so accessible to other
2557 threads, which may be run by DECREF */
2558 for (i = 0; i < PyList_GET_SIZE(names); i++) {
2559 PyObject *name, *value;
2560 name = PyList_GET_ITEM(names, i);
2561 value = PyObject_GetAttr(obj, name);
2562 if (value == NULL)
2563 PyErr_Clear();
2564 else {
2565 int err = PyDict_SetItem(slots, name,
2566 value);
2567 Py_DECREF(value);
2568 if (err)
2569 goto end;
2570 n++;
2571 }
2572 }
2573 if (n) {
2574 state = Py_BuildValue("(NO)", state, slots);
2575 if (state == NULL)
2576 goto end;
2577 }
2578 }
2579 }
2580
2581 if (!PyList_Check(obj)) {
2582 listitems = Py_None;
2583 Py_INCREF(listitems);
2584 }
2585 else {
2586 listitems = PyObject_GetIter(obj);
2587 if (listitems == NULL)
2588 goto end;
2589 }
2590
2591 if (!PyDict_Check(obj)) {
2592 dictitems = Py_None;
2593 Py_INCREF(dictitems);
2594 }
2595 else {
2596 dictitems = PyObject_CallMethod(obj, "iteritems", "");
2597 if (dictitems == NULL)
2598 goto end;
2599 }
2600
2601 copy_reg = import_copy_reg();
2602 if (copy_reg == NULL)
2603 goto end;
2604 newobj = PyObject_GetAttrString(copy_reg, "__newobj__");
2605 if (newobj == NULL)
2606 goto end;
2607
2608 n = PyTuple_GET_SIZE(args);
2609 args2 = PyTuple_New(n+1);
2610 if (args2 == NULL)
2611 goto end;
2612 PyTuple_SET_ITEM(args2, 0, cls);
2613 cls = NULL;
2614 for (i = 0; i < n; i++) {
2615 PyObject *v = PyTuple_GET_ITEM(args, i);
2616 Py_INCREF(v);
2617 PyTuple_SET_ITEM(args2, i+1, v);
2618 }
2619
2620 res = Py_BuildValue("(OOOOO)",
2621 newobj, args2, state, listitems, dictitems);
2622
2623 end:
2624 Py_XDECREF(cls);
2625 Py_XDECREF(args);
2626 Py_XDECREF(args2);
Jeremy Hyltond06483c2003-04-09 21:01:42 +00002627 Py_XDECREF(slots);
Guido van Rossum036f9992003-02-21 22:02:54 +00002628 Py_XDECREF(state);
2629 Py_XDECREF(names);
2630 Py_XDECREF(listitems);
2631 Py_XDECREF(dictitems);
2632 Py_XDECREF(copy_reg);
2633 Py_XDECREF(newobj);
2634 return res;
2635}
2636
2637static PyObject *
2638object_reduce_ex(PyObject *self, PyObject *args)
2639{
2640 /* Call copy_reg._reduce_ex(self, proto) */
2641 PyObject *reduce, *copy_reg, *res;
2642 int proto = 0;
2643
2644 if (!PyArg_ParseTuple(args, "|i:__reduce_ex__", &proto))
2645 return NULL;
2646
2647 reduce = PyObject_GetAttrString(self, "__reduce__");
2648 if (reduce == NULL)
2649 PyErr_Clear();
2650 else {
2651 PyObject *cls, *clsreduce, *objreduce;
2652 int override;
2653 cls = PyObject_GetAttrString(self, "__class__");
2654 if (cls == NULL) {
2655 Py_DECREF(reduce);
2656 return NULL;
2657 }
2658 clsreduce = PyObject_GetAttrString(cls, "__reduce__");
2659 Py_DECREF(cls);
2660 if (clsreduce == NULL) {
2661 Py_DECREF(reduce);
2662 return NULL;
2663 }
2664 objreduce = PyDict_GetItemString(PyBaseObject_Type.tp_dict,
2665 "__reduce__");
2666 override = (clsreduce != objreduce);
2667 Py_DECREF(clsreduce);
2668 if (override) {
2669 res = PyObject_CallObject(reduce, NULL);
2670 Py_DECREF(reduce);
2671 return res;
2672 }
2673 else
2674 Py_DECREF(reduce);
2675 }
2676
2677 if (proto >= 2)
2678 return reduce_2(self);
2679
2680 copy_reg = import_copy_reg();
Guido van Rossum3926a632001-09-25 16:25:58 +00002681 if (!copy_reg)
2682 return NULL;
Guido van Rossum036f9992003-02-21 22:02:54 +00002683
Guido van Rossumc53f0092003-02-18 22:05:12 +00002684 res = PyEval_CallMethod(copy_reg, "_reduce_ex", "(Oi)", self, proto);
Guido van Rossum3926a632001-09-25 16:25:58 +00002685 Py_DECREF(copy_reg);
Guido van Rossum036f9992003-02-21 22:02:54 +00002686
Guido van Rossum3926a632001-09-25 16:25:58 +00002687 return res;
2688}
2689
2690static PyMethodDef object_methods[] = {
Guido van Rossumc53f0092003-02-18 22:05:12 +00002691 {"__reduce_ex__", object_reduce_ex, METH_VARARGS,
2692 PyDoc_STR("helper for pickle")},
2693 {"__reduce__", object_reduce_ex, METH_VARARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002694 PyDoc_STR("helper for pickle")},
Guido van Rossum3926a632001-09-25 16:25:58 +00002695 {0}
2696};
2697
Guido van Rossum036f9992003-02-21 22:02:54 +00002698
Tim Peters6d6c1a32001-08-02 04:15:00 +00002699PyTypeObject PyBaseObject_Type = {
2700 PyObject_HEAD_INIT(&PyType_Type)
2701 0, /* ob_size */
2702 "object", /* tp_name */
2703 sizeof(PyObject), /* tp_basicsize */
2704 0, /* tp_itemsize */
2705 (destructor)object_dealloc, /* tp_dealloc */
2706 0, /* tp_print */
2707 0, /* tp_getattr */
2708 0, /* tp_setattr */
2709 0, /* tp_compare */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002710 object_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002711 0, /* tp_as_number */
2712 0, /* tp_as_sequence */
2713 0, /* tp_as_mapping */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002714 object_hash, /* tp_hash */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002715 0, /* tp_call */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002716 object_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002717 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002718 PyObject_GenericSetAttr, /* tp_setattro */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002719 0, /* tp_as_buffer */
2720 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002721 PyDoc_STR("The most base type"), /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002722 0, /* tp_traverse */
2723 0, /* tp_clear */
2724 0, /* tp_richcompare */
2725 0, /* tp_weaklistoffset */
2726 0, /* tp_iter */
2727 0, /* tp_iternext */
Guido van Rossum3926a632001-09-25 16:25:58 +00002728 object_methods, /* tp_methods */
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002729 0, /* tp_members */
2730 object_getsets, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002731 0, /* tp_base */
2732 0, /* tp_dict */
2733 0, /* tp_descr_get */
2734 0, /* tp_descr_set */
2735 0, /* tp_dictoffset */
2736 object_init, /* tp_init */
2737 PyType_GenericAlloc, /* tp_alloc */
Guido van Rossum298e4212003-02-13 16:30:16 +00002738 object_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002739 PyObject_Del, /* tp_free */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002740};
2741
2742
2743/* Initialize the __dict__ in a type object */
2744
2745static int
2746add_methods(PyTypeObject *type, PyMethodDef *meth)
2747{
Guido van Rossum687ae002001-10-15 22:03:32 +00002748 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002749
2750 for (; meth->ml_name != NULL; meth++) {
2751 PyObject *descr;
2752 if (PyDict_GetItemString(dict, meth->ml_name))
2753 continue;
Fred Drake7bf97152002-03-28 05:33:33 +00002754 if (meth->ml_flags & METH_CLASS) {
2755 if (meth->ml_flags & METH_STATIC) {
2756 PyErr_SetString(PyExc_ValueError,
2757 "method cannot be both class and static");
2758 return -1;
2759 }
Tim Petersbca1cbc2002-12-09 22:56:13 +00002760 descr = PyDescr_NewClassMethod(type, meth);
Fred Drake7bf97152002-03-28 05:33:33 +00002761 }
2762 else if (meth->ml_flags & METH_STATIC) {
Guido van Rossum9af48ff2003-02-11 17:12:46 +00002763 PyObject *cfunc = PyCFunction_New(meth, NULL);
2764 if (cfunc == NULL)
2765 return -1;
2766 descr = PyStaticMethod_New(cfunc);
2767 Py_DECREF(cfunc);
Fred Drake7bf97152002-03-28 05:33:33 +00002768 }
2769 else {
2770 descr = PyDescr_NewMethod(type, meth);
2771 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002772 if (descr == NULL)
2773 return -1;
Fred Drake7bf97152002-03-28 05:33:33 +00002774 if (PyDict_SetItemString(dict, meth->ml_name, descr) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002775 return -1;
2776 Py_DECREF(descr);
2777 }
2778 return 0;
2779}
2780
2781static int
Guido van Rossum6f799372001-09-20 20:46:19 +00002782add_members(PyTypeObject *type, PyMemberDef *memb)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002783{
Guido van Rossum687ae002001-10-15 22:03:32 +00002784 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002785
2786 for (; memb->name != NULL; memb++) {
2787 PyObject *descr;
2788 if (PyDict_GetItemString(dict, memb->name))
2789 continue;
2790 descr = PyDescr_NewMember(type, memb);
2791 if (descr == NULL)
2792 return -1;
2793 if (PyDict_SetItemString(dict, memb->name, descr) < 0)
2794 return -1;
2795 Py_DECREF(descr);
2796 }
2797 return 0;
2798}
2799
2800static int
Guido van Rossum32d34c82001-09-20 21:45:26 +00002801add_getset(PyTypeObject *type, PyGetSetDef *gsp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002802{
Guido van Rossum687ae002001-10-15 22:03:32 +00002803 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002804
2805 for (; gsp->name != NULL; gsp++) {
2806 PyObject *descr;
2807 if (PyDict_GetItemString(dict, gsp->name))
2808 continue;
2809 descr = PyDescr_NewGetSet(type, gsp);
2810
2811 if (descr == NULL)
2812 return -1;
2813 if (PyDict_SetItemString(dict, gsp->name, descr) < 0)
2814 return -1;
2815 Py_DECREF(descr);
2816 }
2817 return 0;
2818}
2819
Guido van Rossum13d52f02001-08-10 21:24:08 +00002820static void
2821inherit_special(PyTypeObject *type, PyTypeObject *base)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002822{
2823 int oldsize, newsize;
2824
Guido van Rossum13d52f02001-08-10 21:24:08 +00002825 /* Special flag magic */
2826 if (!type->tp_as_buffer && base->tp_as_buffer) {
2827 type->tp_flags &= ~Py_TPFLAGS_HAVE_GETCHARBUFFER;
2828 type->tp_flags |=
2829 base->tp_flags & Py_TPFLAGS_HAVE_GETCHARBUFFER;
2830 }
2831 if (!type->tp_as_sequence && base->tp_as_sequence) {
2832 type->tp_flags &= ~Py_TPFLAGS_HAVE_SEQUENCE_IN;
2833 type->tp_flags |= base->tp_flags & Py_TPFLAGS_HAVE_SEQUENCE_IN;
2834 }
2835 if ((type->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS) !=
2836 (base->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS)) {
2837 if ((!type->tp_as_number && base->tp_as_number) ||
2838 (!type->tp_as_sequence && base->tp_as_sequence)) {
2839 type->tp_flags &= ~Py_TPFLAGS_HAVE_INPLACEOPS;
2840 if (!type->tp_as_number && !type->tp_as_sequence) {
2841 type->tp_flags |= base->tp_flags &
2842 Py_TPFLAGS_HAVE_INPLACEOPS;
2843 }
2844 }
2845 /* Wow */
2846 }
2847 if (!type->tp_as_number && base->tp_as_number) {
2848 type->tp_flags &= ~Py_TPFLAGS_CHECKTYPES;
2849 type->tp_flags |= base->tp_flags & Py_TPFLAGS_CHECKTYPES;
2850 }
2851
2852 /* Copying basicsize is connected to the GC flags */
Neil Schemenauerc806c882001-08-29 23:54:54 +00002853 oldsize = base->tp_basicsize;
2854 newsize = type->tp_basicsize ? type->tp_basicsize : oldsize;
2855 if (!(type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
2856 (base->tp_flags & Py_TPFLAGS_HAVE_GC) &&
Guido van Rossum13d52f02001-08-10 21:24:08 +00002857 (type->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE/*GC slots exist*/) &&
2858 (!type->tp_traverse && !type->tp_clear)) {
Neil Schemenauerc806c882001-08-29 23:54:54 +00002859 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossum13d52f02001-08-10 21:24:08 +00002860 if (type->tp_traverse == NULL)
2861 type->tp_traverse = base->tp_traverse;
2862 if (type->tp_clear == NULL)
2863 type->tp_clear = base->tp_clear;
2864 }
2865 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
Guido van Rossumf884b742001-12-17 17:14:22 +00002866 /* The condition below could use some explanation.
2867 It appears that tp_new is not inherited for static types
2868 whose base class is 'object'; this seems to be a precaution
2869 so that old extension types don't suddenly become
2870 callable (object.__new__ wouldn't insure the invariants
2871 that the extension type's own factory function ensures).
2872 Heap types, of course, are under our control, so they do
2873 inherit tp_new; static extension types that specify some
2874 other built-in type as the default are considered
2875 new-style-aware so they also inherit object.__new__. */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002876 if (base != &PyBaseObject_Type ||
2877 (type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2878 if (type->tp_new == NULL)
2879 type->tp_new = base->tp_new;
2880 }
2881 }
Neil Schemenauerc806c882001-08-29 23:54:54 +00002882 type->tp_basicsize = newsize;
Guido van Rossum4dd64ab2001-08-14 20:04:48 +00002883
2884 /* Copy other non-function slots */
2885
2886#undef COPYVAL
2887#define COPYVAL(SLOT) \
2888 if (type->SLOT == 0) type->SLOT = base->SLOT
2889
2890 COPYVAL(tp_itemsize);
2891 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_WEAKREFS) {
2892 COPYVAL(tp_weaklistoffset);
2893 }
2894 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
2895 COPYVAL(tp_dictoffset);
2896 }
Guido van Rossum13d52f02001-08-10 21:24:08 +00002897}
2898
2899static void
2900inherit_slots(PyTypeObject *type, PyTypeObject *base)
2901{
2902 PyTypeObject *basebase;
2903
2904#undef SLOTDEFINED
Tim Peters6d6c1a32001-08-02 04:15:00 +00002905#undef COPYSLOT
2906#undef COPYNUM
2907#undef COPYSEQ
2908#undef COPYMAP
Guido van Rossum5af588b2001-10-12 14:13:21 +00002909#undef COPYBUF
Guido van Rossum13d52f02001-08-10 21:24:08 +00002910
2911#define SLOTDEFINED(SLOT) \
2912 (base->SLOT != 0 && \
2913 (basebase == NULL || base->SLOT != basebase->SLOT))
2914
Tim Peters6d6c1a32001-08-02 04:15:00 +00002915#define COPYSLOT(SLOT) \
Guido van Rossum13d52f02001-08-10 21:24:08 +00002916 if (!type->SLOT && SLOTDEFINED(SLOT)) type->SLOT = base->SLOT
Tim Peters6d6c1a32001-08-02 04:15:00 +00002917
2918#define COPYNUM(SLOT) COPYSLOT(tp_as_number->SLOT)
2919#define COPYSEQ(SLOT) COPYSLOT(tp_as_sequence->SLOT)
2920#define COPYMAP(SLOT) COPYSLOT(tp_as_mapping->SLOT)
Tim Petersfc57ccb2001-10-12 02:38:24 +00002921#define COPYBUF(SLOT) COPYSLOT(tp_as_buffer->SLOT)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002922
Guido van Rossum13d52f02001-08-10 21:24:08 +00002923 /* This won't inherit indirect slots (from tp_as_number etc.)
2924 if type doesn't provide the space. */
2925
2926 if (type->tp_as_number != NULL && base->tp_as_number != NULL) {
2927 basebase = base->tp_base;
2928 if (basebase->tp_as_number == NULL)
2929 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002930 COPYNUM(nb_add);
2931 COPYNUM(nb_subtract);
2932 COPYNUM(nb_multiply);
2933 COPYNUM(nb_divide);
2934 COPYNUM(nb_remainder);
2935 COPYNUM(nb_divmod);
2936 COPYNUM(nb_power);
2937 COPYNUM(nb_negative);
2938 COPYNUM(nb_positive);
2939 COPYNUM(nb_absolute);
2940 COPYNUM(nb_nonzero);
2941 COPYNUM(nb_invert);
2942 COPYNUM(nb_lshift);
2943 COPYNUM(nb_rshift);
2944 COPYNUM(nb_and);
2945 COPYNUM(nb_xor);
2946 COPYNUM(nb_or);
2947 COPYNUM(nb_coerce);
2948 COPYNUM(nb_int);
2949 COPYNUM(nb_long);
2950 COPYNUM(nb_float);
2951 COPYNUM(nb_oct);
2952 COPYNUM(nb_hex);
2953 COPYNUM(nb_inplace_add);
2954 COPYNUM(nb_inplace_subtract);
2955 COPYNUM(nb_inplace_multiply);
2956 COPYNUM(nb_inplace_divide);
2957 COPYNUM(nb_inplace_remainder);
2958 COPYNUM(nb_inplace_power);
2959 COPYNUM(nb_inplace_lshift);
2960 COPYNUM(nb_inplace_rshift);
2961 COPYNUM(nb_inplace_and);
2962 COPYNUM(nb_inplace_xor);
2963 COPYNUM(nb_inplace_or);
Guido van Rossumdc91b992001-08-08 22:26:22 +00002964 if (base->tp_flags & Py_TPFLAGS_CHECKTYPES) {
2965 COPYNUM(nb_true_divide);
2966 COPYNUM(nb_floor_divide);
2967 COPYNUM(nb_inplace_true_divide);
2968 COPYNUM(nb_inplace_floor_divide);
2969 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002970 }
2971
Guido van Rossum13d52f02001-08-10 21:24:08 +00002972 if (type->tp_as_sequence != NULL && base->tp_as_sequence != NULL) {
2973 basebase = base->tp_base;
2974 if (basebase->tp_as_sequence == NULL)
2975 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002976 COPYSEQ(sq_length);
2977 COPYSEQ(sq_concat);
2978 COPYSEQ(sq_repeat);
2979 COPYSEQ(sq_item);
2980 COPYSEQ(sq_slice);
2981 COPYSEQ(sq_ass_item);
2982 COPYSEQ(sq_ass_slice);
2983 COPYSEQ(sq_contains);
2984 COPYSEQ(sq_inplace_concat);
2985 COPYSEQ(sq_inplace_repeat);
2986 }
2987
Guido van Rossum13d52f02001-08-10 21:24:08 +00002988 if (type->tp_as_mapping != NULL && base->tp_as_mapping != NULL) {
2989 basebase = base->tp_base;
2990 if (basebase->tp_as_mapping == NULL)
2991 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002992 COPYMAP(mp_length);
2993 COPYMAP(mp_subscript);
2994 COPYMAP(mp_ass_subscript);
2995 }
2996
Tim Petersfc57ccb2001-10-12 02:38:24 +00002997 if (type->tp_as_buffer != NULL && base->tp_as_buffer != NULL) {
2998 basebase = base->tp_base;
2999 if (basebase->tp_as_buffer == NULL)
3000 basebase = NULL;
3001 COPYBUF(bf_getreadbuffer);
3002 COPYBUF(bf_getwritebuffer);
3003 COPYBUF(bf_getsegcount);
3004 COPYBUF(bf_getcharbuffer);
3005 }
3006
Guido van Rossum13d52f02001-08-10 21:24:08 +00003007 basebase = base->tp_base;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003008
Tim Peters6d6c1a32001-08-02 04:15:00 +00003009 COPYSLOT(tp_dealloc);
3010 COPYSLOT(tp_print);
3011 if (type->tp_getattr == NULL && type->tp_getattro == NULL) {
3012 type->tp_getattr = base->tp_getattr;
3013 type->tp_getattro = base->tp_getattro;
3014 }
3015 if (type->tp_setattr == NULL && type->tp_setattro == NULL) {
3016 type->tp_setattr = base->tp_setattr;
3017 type->tp_setattro = base->tp_setattro;
3018 }
3019 /* tp_compare see tp_richcompare */
3020 COPYSLOT(tp_repr);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003021 /* tp_hash see tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003022 COPYSLOT(tp_call);
3023 COPYSLOT(tp_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003024 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003025 if (type->tp_compare == NULL &&
3026 type->tp_richcompare == NULL &&
3027 type->tp_hash == NULL)
3028 {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003029 type->tp_compare = base->tp_compare;
3030 type->tp_richcompare = base->tp_richcompare;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003031 type->tp_hash = base->tp_hash;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003032 }
3033 }
3034 else {
3035 COPYSLOT(tp_compare);
3036 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003037 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_ITER) {
3038 COPYSLOT(tp_iter);
3039 COPYSLOT(tp_iternext);
3040 }
3041 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3042 COPYSLOT(tp_descr_get);
3043 COPYSLOT(tp_descr_set);
3044 COPYSLOT(tp_dictoffset);
3045 COPYSLOT(tp_init);
3046 COPYSLOT(tp_alloc);
Guido van Rossumcc8fe042002-04-05 17:10:16 +00003047 COPYSLOT(tp_is_gc);
Tim Peters3cfe7542003-05-21 21:29:48 +00003048 if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) ==
3049 (base->tp_flags & Py_TPFLAGS_HAVE_GC)) {
3050 /* They agree about gc. */
3051 COPYSLOT(tp_free);
3052 }
3053 else if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3054 type->tp_free == NULL &&
3055 base->tp_free == _PyObject_Del) {
3056 /* A bit of magic to plug in the correct default
3057 * tp_free function when a derived class adds gc,
3058 * didn't define tp_free, and the base uses the
3059 * default non-gc tp_free.
3060 */
3061 type->tp_free = PyObject_GC_Del;
3062 }
3063 /* else they didn't agree about gc, and there isn't something
3064 * obvious to be done -- the type is on its own.
3065 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003066 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003067}
3068
Jeremy Hylton938ace62002-07-17 16:30:39 +00003069static int add_operators(PyTypeObject *);
Guido van Rossum13d52f02001-08-10 21:24:08 +00003070
Tim Peters6d6c1a32001-08-02 04:15:00 +00003071int
Guido van Rossum528b7eb2001-08-07 17:24:28 +00003072PyType_Ready(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003073{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003074 PyObject *dict, *bases;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003075 PyTypeObject *base;
3076 int i, n;
3077
Guido van Rossumcab05802002-06-10 15:29:03 +00003078 if (type->tp_flags & Py_TPFLAGS_READY) {
3079 assert(type->tp_dict != NULL);
Guido van Rossumd614f972001-08-10 17:39:49 +00003080 return 0;
Guido van Rossumcab05802002-06-10 15:29:03 +00003081 }
Guido van Rossumd614f972001-08-10 17:39:49 +00003082 assert((type->tp_flags & Py_TPFLAGS_READYING) == 0);
Guido van Rossumd614f972001-08-10 17:39:49 +00003083
3084 type->tp_flags |= Py_TPFLAGS_READYING;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003085
Tim Peters36eb4df2003-03-23 03:33:13 +00003086#ifdef Py_TRACE_REFS
3087 /* PyType_Ready is the closest thing we have to a choke point
3088 * for type objects, so is the best place I can think of to try
3089 * to get type objects into the doubly-linked list of all objects.
3090 * Still, not all type objects go thru PyType_Ready.
3091 */
Tim Peters7571a0f2003-03-23 17:52:28 +00003092 _Py_AddToAllObjects((PyObject *)type, 0);
Tim Peters36eb4df2003-03-23 03:33:13 +00003093#endif
3094
Tim Peters6d6c1a32001-08-02 04:15:00 +00003095 /* Initialize tp_base (defaults to BaseObject unless that's us) */
3096 base = type->tp_base;
3097 if (base == NULL && type != &PyBaseObject_Type)
3098 base = type->tp_base = &PyBaseObject_Type;
3099
Guido van Rossum323a9cf2002-08-14 17:26:30 +00003100 /* Initialize the base class */
3101 if (base && base->tp_dict == NULL) {
3102 if (PyType_Ready(base) < 0)
3103 goto error;
3104 }
3105
Guido van Rossum0986d822002-04-08 01:38:42 +00003106 /* Initialize ob_type if NULL. This means extensions that want to be
3107 compilable separately on Windows can call PyType_Ready() instead of
3108 initializing the ob_type field of their type objects. */
3109 if (type->ob_type == NULL)
3110 type->ob_type = base->ob_type;
3111
Tim Peters6d6c1a32001-08-02 04:15:00 +00003112 /* Initialize tp_bases */
3113 bases = type->tp_bases;
3114 if (bases == NULL) {
3115 if (base == NULL)
3116 bases = PyTuple_New(0);
3117 else
3118 bases = Py_BuildValue("(O)", base);
3119 if (bases == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003120 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003121 type->tp_bases = bases;
3122 }
3123
Guido van Rossum687ae002001-10-15 22:03:32 +00003124 /* Initialize tp_dict */
3125 dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003126 if (dict == NULL) {
3127 dict = PyDict_New();
3128 if (dict == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003129 goto error;
Guido van Rossum687ae002001-10-15 22:03:32 +00003130 type->tp_dict = dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003131 }
3132
Guido van Rossum687ae002001-10-15 22:03:32 +00003133 /* Add type-specific descriptors to tp_dict */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003134 if (add_operators(type) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003135 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003136 if (type->tp_methods != NULL) {
3137 if (add_methods(type, type->tp_methods) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003138 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003139 }
3140 if (type->tp_members != NULL) {
3141 if (add_members(type, type->tp_members) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003142 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003143 }
3144 if (type->tp_getset != NULL) {
3145 if (add_getset(type, type->tp_getset) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003146 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003147 }
3148
Tim Peters6d6c1a32001-08-02 04:15:00 +00003149 /* Calculate method resolution order */
3150 if (mro_internal(type) < 0) {
Guido van Rossumd614f972001-08-10 17:39:49 +00003151 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003152 }
3153
Guido van Rossum13d52f02001-08-10 21:24:08 +00003154 /* Inherit special flags from dominant base */
3155 if (type->tp_base != NULL)
3156 inherit_special(type, type->tp_base);
3157
Tim Peters6d6c1a32001-08-02 04:15:00 +00003158 /* Initialize tp_dict properly */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003159 bases = type->tp_mro;
3160 assert(bases != NULL);
3161 assert(PyTuple_Check(bases));
3162 n = PyTuple_GET_SIZE(bases);
3163 for (i = 1; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003164 PyObject *b = PyTuple_GET_ITEM(bases, i);
3165 if (PyType_Check(b))
3166 inherit_slots(type, (PyTypeObject *)b);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003167 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003168
Tim Peters3cfe7542003-05-21 21:29:48 +00003169 /* Sanity check for tp_free. */
3170 if (PyType_IS_GC(type) && (type->tp_flags & Py_TPFLAGS_BASETYPE) &&
3171 (type->tp_free == NULL || type->tp_free == PyObject_Del)) {
3172 /* This base class needs to call tp_free, but doesn't have
3173 * one, or its tp_free is for non-gc'ed objects.
3174 */
3175 PyErr_Format(PyExc_TypeError, "type '%.100s' participates in "
3176 "gc and is a base type but has inappropriate "
3177 "tp_free slot",
3178 type->tp_name);
3179 goto error;
3180 }
3181
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003182 /* if the type dictionary doesn't contain a __doc__, set it from
3183 the tp_doc slot.
3184 */
3185 if (PyDict_GetItemString(type->tp_dict, "__doc__") == NULL) {
3186 if (type->tp_doc != NULL) {
3187 PyObject *doc = PyString_FromString(type->tp_doc);
3188 PyDict_SetItemString(type->tp_dict, "__doc__", doc);
3189 Py_DECREF(doc);
3190 } else {
Guido van Rossumd4641072002-04-03 02:13:37 +00003191 PyDict_SetItemString(type->tp_dict,
3192 "__doc__", Py_None);
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003193 }
3194 }
3195
Guido van Rossum13d52f02001-08-10 21:24:08 +00003196 /* Some more special stuff */
3197 base = type->tp_base;
3198 if (base != NULL) {
3199 if (type->tp_as_number == NULL)
3200 type->tp_as_number = base->tp_as_number;
3201 if (type->tp_as_sequence == NULL)
3202 type->tp_as_sequence = base->tp_as_sequence;
3203 if (type->tp_as_mapping == NULL)
3204 type->tp_as_mapping = base->tp_as_mapping;
Guido van Rossumeea47182003-02-11 20:39:59 +00003205 if (type->tp_as_buffer == NULL)
3206 type->tp_as_buffer = base->tp_as_buffer;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003207 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003208
Guido van Rossum1c450732001-10-08 15:18:27 +00003209 /* Link into each base class's list of subclasses */
3210 bases = type->tp_bases;
3211 n = PyTuple_GET_SIZE(bases);
3212 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003213 PyObject *b = PyTuple_GET_ITEM(bases, i);
3214 if (PyType_Check(b) &&
3215 add_subclass((PyTypeObject *)b, type) < 0)
Guido van Rossum1c450732001-10-08 15:18:27 +00003216 goto error;
3217 }
3218
Guido van Rossum13d52f02001-08-10 21:24:08 +00003219 /* All done -- set the ready flag */
Guido van Rossumd614f972001-08-10 17:39:49 +00003220 assert(type->tp_dict != NULL);
3221 type->tp_flags =
3222 (type->tp_flags & ~Py_TPFLAGS_READYING) | Py_TPFLAGS_READY;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003223 return 0;
Guido van Rossumd614f972001-08-10 17:39:49 +00003224
3225 error:
3226 type->tp_flags &= ~Py_TPFLAGS_READYING;
3227 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003228}
3229
Guido van Rossum1c450732001-10-08 15:18:27 +00003230static int
3231add_subclass(PyTypeObject *base, PyTypeObject *type)
3232{
3233 int i;
3234 PyObject *list, *ref, *new;
3235
3236 list = base->tp_subclasses;
3237 if (list == NULL) {
3238 base->tp_subclasses = list = PyList_New(0);
3239 if (list == NULL)
3240 return -1;
3241 }
3242 assert(PyList_Check(list));
3243 new = PyWeakref_NewRef((PyObject *)type, NULL);
3244 i = PyList_GET_SIZE(list);
3245 while (--i >= 0) {
3246 ref = PyList_GET_ITEM(list, i);
3247 assert(PyWeakref_CheckRef(ref));
Guido van Rossum3930bc32002-10-18 13:51:49 +00003248 if (PyWeakref_GET_OBJECT(ref) == Py_None)
3249 return PyList_SetItem(list, i, new);
Guido van Rossum1c450732001-10-08 15:18:27 +00003250 }
3251 i = PyList_Append(list, new);
3252 Py_DECREF(new);
3253 return i;
3254}
3255
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003256static void
3257remove_subclass(PyTypeObject *base, PyTypeObject *type)
3258{
3259 int i;
3260 PyObject *list, *ref;
3261
3262 list = base->tp_subclasses;
3263 if (list == NULL) {
3264 return;
3265 }
3266 assert(PyList_Check(list));
3267 i = PyList_GET_SIZE(list);
3268 while (--i >= 0) {
3269 ref = PyList_GET_ITEM(list, i);
3270 assert(PyWeakref_CheckRef(ref));
3271 if (PyWeakref_GET_OBJECT(ref) == (PyObject*)type) {
3272 /* this can't fail, right? */
3273 PySequence_DelItem(list, i);
3274 return;
3275 }
3276 }
3277}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003278
3279/* Generic wrappers for overloadable 'operators' such as __getitem__ */
3280
3281/* There's a wrapper *function* for each distinct function typedef used
3282 for type object slots (e.g. binaryfunc, ternaryfunc, etc.). There's a
3283 wrapper *table* for each distinct operation (e.g. __len__, __add__).
3284 Most tables have only one entry; the tables for binary operators have two
3285 entries, one regular and one with reversed arguments. */
3286
3287static PyObject *
3288wrap_inquiry(PyObject *self, PyObject *args, void *wrapped)
3289{
3290 inquiry func = (inquiry)wrapped;
3291 int res;
3292
3293 if (!PyArg_ParseTuple(args, ""))
3294 return NULL;
3295 res = (*func)(self);
3296 if (res == -1 && PyErr_Occurred())
3297 return NULL;
3298 return PyInt_FromLong((long)res);
3299}
3300
Tim Peters6d6c1a32001-08-02 04:15:00 +00003301static PyObject *
3302wrap_binaryfunc(PyObject *self, PyObject *args, void *wrapped)
3303{
3304 binaryfunc func = (binaryfunc)wrapped;
3305 PyObject *other;
3306
3307 if (!PyArg_ParseTuple(args, "O", &other))
3308 return NULL;
3309 return (*func)(self, other);
3310}
3311
3312static PyObject *
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003313wrap_binaryfunc_l(PyObject *self, PyObject *args, void *wrapped)
3314{
3315 binaryfunc func = (binaryfunc)wrapped;
3316 PyObject *other;
3317
3318 if (!PyArg_ParseTuple(args, "O", &other))
3319 return NULL;
3320 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003321 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003322 Py_INCREF(Py_NotImplemented);
3323 return Py_NotImplemented;
3324 }
3325 return (*func)(self, other);
3326}
3327
3328static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003329wrap_binaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3330{
3331 binaryfunc func = (binaryfunc)wrapped;
3332 PyObject *other;
3333
3334 if (!PyArg_ParseTuple(args, "O", &other))
3335 return NULL;
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003336 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003337 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003338 Py_INCREF(Py_NotImplemented);
3339 return Py_NotImplemented;
3340 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003341 return (*func)(other, self);
3342}
3343
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003344static PyObject *
3345wrap_coercefunc(PyObject *self, PyObject *args, void *wrapped)
3346{
3347 coercion func = (coercion)wrapped;
3348 PyObject *other, *res;
3349 int ok;
3350
3351 if (!PyArg_ParseTuple(args, "O", &other))
3352 return NULL;
3353 ok = func(&self, &other);
3354 if (ok < 0)
3355 return NULL;
3356 if (ok > 0) {
3357 Py_INCREF(Py_NotImplemented);
3358 return Py_NotImplemented;
3359 }
3360 res = PyTuple_New(2);
3361 if (res == NULL) {
3362 Py_DECREF(self);
3363 Py_DECREF(other);
3364 return NULL;
3365 }
3366 PyTuple_SET_ITEM(res, 0, self);
3367 PyTuple_SET_ITEM(res, 1, other);
3368 return res;
3369}
3370
Tim Peters6d6c1a32001-08-02 04:15:00 +00003371static PyObject *
3372wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)
3373{
3374 ternaryfunc func = (ternaryfunc)wrapped;
3375 PyObject *other;
3376 PyObject *third = Py_None;
3377
3378 /* Note: This wrapper only works for __pow__() */
3379
3380 if (!PyArg_ParseTuple(args, "O|O", &other, &third))
3381 return NULL;
3382 return (*func)(self, other, third);
3383}
3384
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003385static PyObject *
3386wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3387{
3388 ternaryfunc func = (ternaryfunc)wrapped;
3389 PyObject *other;
3390 PyObject *third = Py_None;
3391
3392 /* Note: This wrapper only works for __pow__() */
3393
3394 if (!PyArg_ParseTuple(args, "O|O", &other, &third))
3395 return NULL;
3396 return (*func)(other, self, third);
3397}
3398
Tim Peters6d6c1a32001-08-02 04:15:00 +00003399static PyObject *
3400wrap_unaryfunc(PyObject *self, PyObject *args, void *wrapped)
3401{
3402 unaryfunc func = (unaryfunc)wrapped;
3403
3404 if (!PyArg_ParseTuple(args, ""))
3405 return NULL;
3406 return (*func)(self);
3407}
3408
Tim Peters6d6c1a32001-08-02 04:15:00 +00003409static PyObject *
3410wrap_intargfunc(PyObject *self, PyObject *args, void *wrapped)
3411{
3412 intargfunc func = (intargfunc)wrapped;
3413 int i;
3414
3415 if (!PyArg_ParseTuple(args, "i", &i))
3416 return NULL;
3417 return (*func)(self, i);
3418}
3419
Guido van Rossum5d815f32001-08-17 21:57:47 +00003420static int
3421getindex(PyObject *self, PyObject *arg)
3422{
3423 int i;
3424
3425 i = PyInt_AsLong(arg);
3426 if (i == -1 && PyErr_Occurred())
3427 return -1;
3428 if (i < 0) {
3429 PySequenceMethods *sq = self->ob_type->tp_as_sequence;
3430 if (sq && sq->sq_length) {
3431 int n = (*sq->sq_length)(self);
3432 if (n < 0)
3433 return -1;
3434 i += n;
3435 }
3436 }
3437 return i;
3438}
3439
3440static PyObject *
3441wrap_sq_item(PyObject *self, PyObject *args, void *wrapped)
3442{
3443 intargfunc func = (intargfunc)wrapped;
3444 PyObject *arg;
3445 int i;
3446
Guido van Rossumf4593e02001-10-03 12:09:30 +00003447 if (PyTuple_GET_SIZE(args) == 1) {
3448 arg = PyTuple_GET_ITEM(args, 0);
3449 i = getindex(self, arg);
3450 if (i == -1 && PyErr_Occurred())
3451 return NULL;
3452 return (*func)(self, i);
3453 }
3454 PyArg_ParseTuple(args, "O", &arg);
3455 assert(PyErr_Occurred());
3456 return NULL;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003457}
3458
Tim Peters6d6c1a32001-08-02 04:15:00 +00003459static PyObject *
3460wrap_intintargfunc(PyObject *self, PyObject *args, void *wrapped)
3461{
3462 intintargfunc func = (intintargfunc)wrapped;
3463 int i, j;
3464
3465 if (!PyArg_ParseTuple(args, "ii", &i, &j))
3466 return NULL;
3467 return (*func)(self, i, j);
3468}
3469
Tim Peters6d6c1a32001-08-02 04:15:00 +00003470static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003471wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003472{
3473 intobjargproc func = (intobjargproc)wrapped;
3474 int i, res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003475 PyObject *arg, *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003476
Guido van Rossum5d815f32001-08-17 21:57:47 +00003477 if (!PyArg_ParseTuple(args, "OO", &arg, &value))
3478 return NULL;
3479 i = getindex(self, arg);
3480 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003481 return NULL;
3482 res = (*func)(self, i, value);
3483 if (res == -1 && PyErr_Occurred())
3484 return NULL;
3485 Py_INCREF(Py_None);
3486 return Py_None;
3487}
3488
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003489static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003490wrap_sq_delitem(PyObject *self, PyObject *args, void *wrapped)
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003491{
3492 intobjargproc func = (intobjargproc)wrapped;
3493 int i, res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003494 PyObject *arg;
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003495
Guido van Rossum5d815f32001-08-17 21:57:47 +00003496 if (!PyArg_ParseTuple(args, "O", &arg))
3497 return NULL;
3498 i = getindex(self, arg);
3499 if (i == -1 && PyErr_Occurred())
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003500 return NULL;
3501 res = (*func)(self, i, NULL);
3502 if (res == -1 && PyErr_Occurred())
3503 return NULL;
3504 Py_INCREF(Py_None);
3505 return Py_None;
3506}
3507
Tim Peters6d6c1a32001-08-02 04:15:00 +00003508static PyObject *
3509wrap_intintobjargproc(PyObject *self, PyObject *args, void *wrapped)
3510{
3511 intintobjargproc func = (intintobjargproc)wrapped;
3512 int i, j, res;
3513 PyObject *value;
3514
3515 if (!PyArg_ParseTuple(args, "iiO", &i, &j, &value))
3516 return NULL;
3517 res = (*func)(self, i, j, value);
3518 if (res == -1 && PyErr_Occurred())
3519 return NULL;
3520 Py_INCREF(Py_None);
3521 return Py_None;
3522}
3523
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003524static PyObject *
3525wrap_delslice(PyObject *self, PyObject *args, void *wrapped)
3526{
3527 intintobjargproc func = (intintobjargproc)wrapped;
3528 int i, j, res;
3529
3530 if (!PyArg_ParseTuple(args, "ii", &i, &j))
3531 return NULL;
3532 res = (*func)(self, i, j, NULL);
3533 if (res == -1 && PyErr_Occurred())
3534 return NULL;
3535 Py_INCREF(Py_None);
3536 return Py_None;
3537}
3538
Tim Peters6d6c1a32001-08-02 04:15:00 +00003539/* XXX objobjproc is a misnomer; should be objargpred */
3540static PyObject *
3541wrap_objobjproc(PyObject *self, PyObject *args, void *wrapped)
3542{
3543 objobjproc func = (objobjproc)wrapped;
3544 int res;
3545 PyObject *value;
3546
3547 if (!PyArg_ParseTuple(args, "O", &value))
3548 return NULL;
3549 res = (*func)(self, value);
3550 if (res == -1 && PyErr_Occurred())
3551 return NULL;
3552 return PyInt_FromLong((long)res);
3553}
3554
Tim Peters6d6c1a32001-08-02 04:15:00 +00003555static PyObject *
3556wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
3557{
3558 objobjargproc func = (objobjargproc)wrapped;
3559 int res;
3560 PyObject *key, *value;
3561
3562 if (!PyArg_ParseTuple(args, "OO", &key, &value))
3563 return NULL;
3564 res = (*func)(self, key, value);
3565 if (res == -1 && PyErr_Occurred())
3566 return NULL;
3567 Py_INCREF(Py_None);
3568 return Py_None;
3569}
3570
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003571static PyObject *
3572wrap_delitem(PyObject *self, PyObject *args, void *wrapped)
3573{
3574 objobjargproc func = (objobjargproc)wrapped;
3575 int res;
3576 PyObject *key;
3577
3578 if (!PyArg_ParseTuple(args, "O", &key))
3579 return NULL;
3580 res = (*func)(self, key, 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_cmpfunc(PyObject *self, PyObject *args, void *wrapped)
3589{
3590 cmpfunc func = (cmpfunc)wrapped;
3591 int res;
3592 PyObject *other;
3593
3594 if (!PyArg_ParseTuple(args, "O", &other))
3595 return NULL;
Guido van Rossum3d45d8f2001-09-24 18:47:40 +00003596 if (other->ob_type->tp_compare != func &&
3597 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossumceccae52001-09-18 20:03:57 +00003598 PyErr_Format(
3599 PyExc_TypeError,
3600 "%s.__cmp__(x,y) requires y to be a '%s', not a '%s'",
3601 self->ob_type->tp_name,
3602 self->ob_type->tp_name,
3603 other->ob_type->tp_name);
3604 return NULL;
3605 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003606 res = (*func)(self, other);
3607 if (PyErr_Occurred())
3608 return NULL;
3609 return PyInt_FromLong((long)res);
3610}
3611
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003612/* Helper to check for object.__setattr__ or __delattr__ applied to a type.
Guido van Rossum52b27052003-04-15 20:05:10 +00003613 This is called the Carlo Verre hack after its discoverer. */
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003614static int
3615hackcheck(PyObject *self, setattrofunc func, char *what)
3616{
3617 PyTypeObject *type = self->ob_type;
3618 while (type && type->tp_flags & Py_TPFLAGS_HEAPTYPE)
3619 type = type->tp_base;
3620 if (type->tp_setattro != func) {
3621 PyErr_Format(PyExc_TypeError,
3622 "can't apply this %s to %s object",
3623 what,
3624 type->tp_name);
3625 return 0;
3626 }
3627 return 1;
3628}
3629
Tim Peters6d6c1a32001-08-02 04:15:00 +00003630static PyObject *
3631wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
3632{
3633 setattrofunc func = (setattrofunc)wrapped;
3634 int res;
3635 PyObject *name, *value;
3636
3637 if (!PyArg_ParseTuple(args, "OO", &name, &value))
3638 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003639 if (!hackcheck(self, func, "__setattr__"))
3640 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003641 res = (*func)(self, name, value);
3642 if (res < 0)
3643 return NULL;
3644 Py_INCREF(Py_None);
3645 return Py_None;
3646}
3647
3648static PyObject *
3649wrap_delattr(PyObject *self, PyObject *args, void *wrapped)
3650{
3651 setattrofunc func = (setattrofunc)wrapped;
3652 int res;
3653 PyObject *name;
3654
3655 if (!PyArg_ParseTuple(args, "O", &name))
3656 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003657 if (!hackcheck(self, func, "__delattr__"))
3658 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003659 res = (*func)(self, name, NULL);
3660 if (res < 0)
3661 return NULL;
3662 Py_INCREF(Py_None);
3663 return Py_None;
3664}
3665
Tim Peters6d6c1a32001-08-02 04:15:00 +00003666static PyObject *
3667wrap_hashfunc(PyObject *self, PyObject *args, void *wrapped)
3668{
3669 hashfunc func = (hashfunc)wrapped;
3670 long res;
3671
3672 if (!PyArg_ParseTuple(args, ""))
3673 return NULL;
3674 res = (*func)(self);
3675 if (res == -1 && PyErr_Occurred())
3676 return NULL;
3677 return PyInt_FromLong(res);
3678}
3679
Tim Peters6d6c1a32001-08-02 04:15:00 +00003680static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003681wrap_call(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003682{
3683 ternaryfunc func = (ternaryfunc)wrapped;
3684
Guido van Rossumc8e56452001-10-22 00:43:43 +00003685 return (*func)(self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003686}
3687
Tim Peters6d6c1a32001-08-02 04:15:00 +00003688static PyObject *
3689wrap_richcmpfunc(PyObject *self, PyObject *args, void *wrapped, int op)
3690{
3691 richcmpfunc func = (richcmpfunc)wrapped;
3692 PyObject *other;
3693
3694 if (!PyArg_ParseTuple(args, "O", &other))
3695 return NULL;
3696 return (*func)(self, other, op);
3697}
3698
3699#undef RICHCMP_WRAPPER
3700#define RICHCMP_WRAPPER(NAME, OP) \
3701static PyObject * \
3702richcmp_##NAME(PyObject *self, PyObject *args, void *wrapped) \
3703{ \
3704 return wrap_richcmpfunc(self, args, wrapped, OP); \
3705}
3706
Jack Jansen8e938b42001-08-08 15:29:49 +00003707RICHCMP_WRAPPER(lt, Py_LT)
3708RICHCMP_WRAPPER(le, Py_LE)
3709RICHCMP_WRAPPER(eq, Py_EQ)
3710RICHCMP_WRAPPER(ne, Py_NE)
3711RICHCMP_WRAPPER(gt, Py_GT)
3712RICHCMP_WRAPPER(ge, Py_GE)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003713
Tim Peters6d6c1a32001-08-02 04:15:00 +00003714static PyObject *
3715wrap_next(PyObject *self, PyObject *args, void *wrapped)
3716{
3717 unaryfunc func = (unaryfunc)wrapped;
3718 PyObject *res;
3719
3720 if (!PyArg_ParseTuple(args, ""))
3721 return NULL;
3722 res = (*func)(self);
3723 if (res == NULL && !PyErr_Occurred())
3724 PyErr_SetNone(PyExc_StopIteration);
3725 return res;
3726}
3727
Tim Peters6d6c1a32001-08-02 04:15:00 +00003728static PyObject *
3729wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
3730{
3731 descrgetfunc func = (descrgetfunc)wrapped;
3732 PyObject *obj;
3733 PyObject *type = NULL;
3734
3735 if (!PyArg_ParseTuple(args, "O|O", &obj, &type))
3736 return NULL;
Guido van Rossum82ed25c2003-02-11 16:25:43 +00003737 if (obj == Py_None)
3738 obj = NULL;
3739 if (type == Py_None)
3740 type = NULL;
3741 if (type == NULL &&obj == NULL) {
3742 PyErr_SetString(PyExc_TypeError,
3743 "__get__(None, None) is invalid");
3744 return NULL;
3745 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003746 return (*func)(self, obj, type);
3747}
3748
Tim Peters6d6c1a32001-08-02 04:15:00 +00003749static PyObject *
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003750wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003751{
3752 descrsetfunc func = (descrsetfunc)wrapped;
3753 PyObject *obj, *value;
3754 int ret;
3755
3756 if (!PyArg_ParseTuple(args, "OO", &obj, &value))
3757 return NULL;
3758 ret = (*func)(self, obj, value);
3759 if (ret < 0)
3760 return NULL;
3761 Py_INCREF(Py_None);
3762 return Py_None;
3763}
Guido van Rossum22b13872002-08-06 21:41:44 +00003764
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003765static PyObject *
3766wrap_descr_delete(PyObject *self, PyObject *args, void *wrapped)
3767{
3768 descrsetfunc func = (descrsetfunc)wrapped;
3769 PyObject *obj;
3770 int ret;
3771
3772 if (!PyArg_ParseTuple(args, "O", &obj))
3773 return NULL;
3774 ret = (*func)(self, obj, NULL);
3775 if (ret < 0)
3776 return NULL;
3777 Py_INCREF(Py_None);
3778 return Py_None;
3779}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003780
Tim Peters6d6c1a32001-08-02 04:15:00 +00003781static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003782wrap_init(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003783{
3784 initproc func = (initproc)wrapped;
3785
Guido van Rossumc8e56452001-10-22 00:43:43 +00003786 if (func(self, args, kwds) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003787 return NULL;
3788 Py_INCREF(Py_None);
3789 return Py_None;
3790}
3791
Tim Peters6d6c1a32001-08-02 04:15:00 +00003792static PyObject *
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003793tp_new_wrapper(PyObject *self, PyObject *args, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003794{
Barry Warsaw60f01882001-08-22 19:24:42 +00003795 PyTypeObject *type, *subtype, *staticbase;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003796 PyObject *arg0, *res;
3797
3798 if (self == NULL || !PyType_Check(self))
3799 Py_FatalError("__new__() called with non-type 'self'");
3800 type = (PyTypeObject *)self;
3801 if (!PyTuple_Check(args) || PyTuple_GET_SIZE(args) < 1) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003802 PyErr_Format(PyExc_TypeError,
3803 "%s.__new__(): not enough arguments",
3804 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003805 return NULL;
3806 }
3807 arg0 = PyTuple_GET_ITEM(args, 0);
3808 if (!PyType_Check(arg0)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003809 PyErr_Format(PyExc_TypeError,
3810 "%s.__new__(X): X is not a type object (%s)",
3811 type->tp_name,
3812 arg0->ob_type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003813 return NULL;
3814 }
3815 subtype = (PyTypeObject *)arg0;
3816 if (!PyType_IsSubtype(subtype, type)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003817 PyErr_Format(PyExc_TypeError,
3818 "%s.__new__(%s): %s is not a subtype of %s",
3819 type->tp_name,
3820 subtype->tp_name,
3821 subtype->tp_name,
3822 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003823 return NULL;
3824 }
Barry Warsaw60f01882001-08-22 19:24:42 +00003825
3826 /* Check that the use doesn't do something silly and unsafe like
Tim Petersa427a2b2001-10-29 22:25:45 +00003827 object.__new__(dict). To do this, we check that the
Barry Warsaw60f01882001-08-22 19:24:42 +00003828 most derived base that's not a heap type is this type. */
3829 staticbase = subtype;
3830 while (staticbase && (staticbase->tp_flags & Py_TPFLAGS_HEAPTYPE))
3831 staticbase = staticbase->tp_base;
Guido van Rossuma8c60f42001-09-14 19:43:36 +00003832 if (staticbase->tp_new != type->tp_new) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003833 PyErr_Format(PyExc_TypeError,
3834 "%s.__new__(%s) is not safe, use %s.__new__()",
3835 type->tp_name,
3836 subtype->tp_name,
3837 staticbase == NULL ? "?" : staticbase->tp_name);
3838 return NULL;
3839 }
3840
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003841 args = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
3842 if (args == NULL)
3843 return NULL;
3844 res = type->tp_new(subtype, args, kwds);
3845 Py_DECREF(args);
3846 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003847}
3848
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003849static struct PyMethodDef tp_new_methoddef[] = {
3850 {"__new__", (PyCFunction)tp_new_wrapper, METH_KEYWORDS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003851 PyDoc_STR("T.__new__(S, ...) -> "
3852 "a new object with type S, a subtype of T")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00003853 {0}
3854};
3855
3856static int
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003857add_tp_new_wrapper(PyTypeObject *type)
3858{
Guido van Rossumf040ede2001-08-07 16:40:56 +00003859 PyObject *func;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003860
Guido van Rossum687ae002001-10-15 22:03:32 +00003861 if (PyDict_GetItemString(type->tp_dict, "__new__") != NULL)
Guido van Rossumf040ede2001-08-07 16:40:56 +00003862 return 0;
3863 func = PyCFunction_New(tp_new_methoddef, (PyObject *)type);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003864 if (func == NULL)
3865 return -1;
Guido van Rossum687ae002001-10-15 22:03:32 +00003866 return PyDict_SetItemString(type->tp_dict, "__new__", func);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003867}
3868
Guido van Rossumf040ede2001-08-07 16:40:56 +00003869/* Slot wrappers that call the corresponding __foo__ slot. See comments
3870 below at override_slots() for more explanation. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003871
Guido van Rossumdc91b992001-08-08 22:26:22 +00003872#define SLOT0(FUNCNAME, OPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003873static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003874FUNCNAME(PyObject *self) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003875{ \
Guido van Rossum5592e4d2001-08-28 18:28:21 +00003876 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003877 return call_method(self, OPSTR, &cache_str, "()"); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003878}
3879
Guido van Rossumdc91b992001-08-08 22:26:22 +00003880#define SLOT1(FUNCNAME, OPSTR, ARG1TYPE, ARGCODES) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003881static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003882FUNCNAME(PyObject *self, ARG1TYPE arg1) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003883{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00003884 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003885 return call_method(self, OPSTR, &cache_str, "(" ARGCODES ")", arg1); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003886}
3887
Guido van Rossumcd118802003-01-06 22:57:47 +00003888/* Boolean helper for SLOT1BINFULL().
3889 right.__class__ is a nontrivial subclass of left.__class__. */
3890static int
3891method_is_overloaded(PyObject *left, PyObject *right, char *name)
3892{
3893 PyObject *a, *b;
3894 int ok;
3895
3896 b = PyObject_GetAttrString((PyObject *)(right->ob_type), name);
3897 if (b == NULL) {
3898 PyErr_Clear();
3899 /* If right doesn't have it, it's not overloaded */
3900 return 0;
3901 }
3902
3903 a = PyObject_GetAttrString((PyObject *)(left->ob_type), name);
3904 if (a == NULL) {
3905 PyErr_Clear();
3906 Py_DECREF(b);
3907 /* If right has it but left doesn't, it's overloaded */
3908 return 1;
3909 }
3910
3911 ok = PyObject_RichCompareBool(a, b, Py_NE);
3912 Py_DECREF(a);
3913 Py_DECREF(b);
3914 if (ok < 0) {
3915 PyErr_Clear();
3916 return 0;
3917 }
3918
3919 return ok;
3920}
3921
Guido van Rossumdc91b992001-08-08 22:26:22 +00003922
3923#define SLOT1BINFULL(FUNCNAME, TESTFUNC, SLOTNAME, OPSTR, ROPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003924static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003925FUNCNAME(PyObject *self, PyObject *other) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003926{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00003927 static PyObject *cache_str, *rcache_str; \
Guido van Rossum55f20992001-10-01 17:18:22 +00003928 int do_other = self->ob_type != other->ob_type && \
3929 other->ob_type->tp_as_number != NULL && \
3930 other->ob_type->tp_as_number->SLOTNAME == TESTFUNC; \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003931 if (self->ob_type->tp_as_number != NULL && \
3932 self->ob_type->tp_as_number->SLOTNAME == TESTFUNC) { \
3933 PyObject *r; \
Guido van Rossum55f20992001-10-01 17:18:22 +00003934 if (do_other && \
Guido van Rossumcd118802003-01-06 22:57:47 +00003935 PyType_IsSubtype(other->ob_type, self->ob_type) && \
3936 method_is_overloaded(self, other, ROPSTR)) { \
Guido van Rossum55f20992001-10-01 17:18:22 +00003937 r = call_maybe( \
3938 other, ROPSTR, &rcache_str, "(O)", self); \
3939 if (r != Py_NotImplemented) \
3940 return r; \
3941 Py_DECREF(r); \
3942 do_other = 0; \
3943 } \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00003944 r = call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00003945 self, OPSTR, &cache_str, "(O)", other); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003946 if (r != Py_NotImplemented || \
3947 other->ob_type == self->ob_type) \
3948 return r; \
3949 Py_DECREF(r); \
3950 } \
Guido van Rossum55f20992001-10-01 17:18:22 +00003951 if (do_other) { \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00003952 return call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00003953 other, ROPSTR, &rcache_str, "(O)", self); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003954 } \
3955 Py_INCREF(Py_NotImplemented); \
3956 return Py_NotImplemented; \
3957}
3958
3959#define SLOT1BIN(FUNCNAME, SLOTNAME, OPSTR, ROPSTR) \
3960 SLOT1BINFULL(FUNCNAME, FUNCNAME, SLOTNAME, OPSTR, ROPSTR)
3961
3962#define SLOT2(FUNCNAME, OPSTR, ARG1TYPE, ARG2TYPE, ARGCODES) \
3963static PyObject * \
3964FUNCNAME(PyObject *self, ARG1TYPE arg1, ARG2TYPE arg2) \
3965{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00003966 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003967 return call_method(self, OPSTR, &cache_str, \
3968 "(" ARGCODES ")", arg1, arg2); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003969}
3970
3971static int
3972slot_sq_length(PyObject *self)
3973{
Guido van Rossum2730b132001-08-28 18:22:14 +00003974 static PyObject *len_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00003975 PyObject *res = call_method(self, "__len__", &len_str, "()");
Guido van Rossum26111622001-10-01 16:42:49 +00003976 int len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003977
3978 if (res == NULL)
3979 return -1;
Guido van Rossum26111622001-10-01 16:42:49 +00003980 len = (int)PyInt_AsLong(res);
3981 Py_DECREF(res);
Jeremy Hylton73a088e2002-07-25 16:43:29 +00003982 if (len == -1 && PyErr_Occurred())
3983 return -1;
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00003984 if (len < 0) {
Guido van Rossum22b13872002-08-06 21:41:44 +00003985 PyErr_SetString(PyExc_ValueError,
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00003986 "__len__() should return >= 0");
3987 return -1;
3988 }
Guido van Rossum26111622001-10-01 16:42:49 +00003989 return len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003990}
3991
Guido van Rossumdc91b992001-08-08 22:26:22 +00003992SLOT1(slot_sq_concat, "__add__", PyObject *, "O")
3993SLOT1(slot_sq_repeat, "__mul__", int, "i")
Guido van Rossumf4593e02001-10-03 12:09:30 +00003994
3995/* Super-optimized version of slot_sq_item.
3996 Other slots could do the same... */
3997static PyObject *
3998slot_sq_item(PyObject *self, int i)
3999{
4000 static PyObject *getitem_str;
4001 PyObject *func, *args = NULL, *ival = NULL, *retval = NULL;
4002 descrgetfunc f;
4003
4004 if (getitem_str == NULL) {
4005 getitem_str = PyString_InternFromString("__getitem__");
4006 if (getitem_str == NULL)
4007 return NULL;
4008 }
4009 func = _PyType_Lookup(self->ob_type, getitem_str);
4010 if (func != NULL) {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004011 if ((f = func->ob_type->tp_descr_get) == NULL)
4012 Py_INCREF(func);
Neal Norwitz673cd822002-10-18 16:33:13 +00004013 else {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004014 func = f(func, self, (PyObject *)(self->ob_type));
Neal Norwitz673cd822002-10-18 16:33:13 +00004015 if (func == NULL) {
4016 return NULL;
4017 }
4018 }
Guido van Rossumf4593e02001-10-03 12:09:30 +00004019 ival = PyInt_FromLong(i);
4020 if (ival != NULL) {
4021 args = PyTuple_New(1);
4022 if (args != NULL) {
4023 PyTuple_SET_ITEM(args, 0, ival);
4024 retval = PyObject_Call(func, args, NULL);
4025 Py_XDECREF(args);
4026 Py_XDECREF(func);
4027 return retval;
4028 }
4029 }
4030 }
4031 else {
4032 PyErr_SetObject(PyExc_AttributeError, getitem_str);
4033 }
4034 Py_XDECREF(args);
4035 Py_XDECREF(ival);
4036 Py_XDECREF(func);
4037 return NULL;
4038}
4039
Guido van Rossumdc91b992001-08-08 22:26:22 +00004040SLOT2(slot_sq_slice, "__getslice__", int, int, "ii")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004041
4042static int
4043slot_sq_ass_item(PyObject *self, int index, PyObject *value)
4044{
4045 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004046 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004047
4048 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004049 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004050 "(i)", index);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004051 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004052 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004053 "(iO)", index, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004054 if (res == NULL)
4055 return -1;
4056 Py_DECREF(res);
4057 return 0;
4058}
4059
4060static int
4061slot_sq_ass_slice(PyObject *self, int i, int j, PyObject *value)
4062{
4063 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004064 static PyObject *delslice_str, *setslice_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004065
4066 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004067 res = call_method(self, "__delslice__", &delslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004068 "(ii)", i, j);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004069 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004070 res = call_method(self, "__setslice__", &setslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004071 "(iiO)", i, j, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004072 if (res == NULL)
4073 return -1;
4074 Py_DECREF(res);
4075 return 0;
4076}
4077
4078static int
4079slot_sq_contains(PyObject *self, PyObject *value)
4080{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004081 PyObject *func, *res, *args;
Tim Petersbf9b2442003-03-23 05:35:36 +00004082 int result = -1;
4083
Guido van Rossum60718732001-08-28 17:47:51 +00004084 static PyObject *contains_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004085
Guido van Rossum55f20992001-10-01 17:18:22 +00004086 func = lookup_maybe(self, "__contains__", &contains_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004087 if (func != NULL) {
4088 args = Py_BuildValue("(O)", value);
4089 if (args == NULL)
4090 res = NULL;
4091 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004092 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004093 Py_DECREF(args);
4094 }
4095 Py_DECREF(func);
Tim Petersbf9b2442003-03-23 05:35:36 +00004096 if (res != NULL) {
4097 result = PyObject_IsTrue(res);
4098 Py_DECREF(res);
4099 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004100 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004101 else if (! PyErr_Occurred()) {
4102 result = _PySequence_IterSearch(self, value,
4103 PY_ITERSEARCH_CONTAINS);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004104 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004105 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004106}
4107
Guido van Rossumdc91b992001-08-08 22:26:22 +00004108SLOT1(slot_sq_inplace_concat, "__iadd__", PyObject *, "O")
4109SLOT1(slot_sq_inplace_repeat, "__imul__", int, "i")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004110
4111#define slot_mp_length slot_sq_length
4112
Guido van Rossumdc91b992001-08-08 22:26:22 +00004113SLOT1(slot_mp_subscript, "__getitem__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004114
4115static int
4116slot_mp_ass_subscript(PyObject *self, PyObject *key, PyObject *value)
4117{
4118 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004119 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004120
4121 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004122 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004123 "(O)", key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004124 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004125 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004126 "(OO)", key, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004127 if (res == NULL)
4128 return -1;
4129 Py_DECREF(res);
4130 return 0;
4131}
4132
Guido van Rossumdc91b992001-08-08 22:26:22 +00004133SLOT1BIN(slot_nb_add, nb_add, "__add__", "__radd__")
4134SLOT1BIN(slot_nb_subtract, nb_subtract, "__sub__", "__rsub__")
4135SLOT1BIN(slot_nb_multiply, nb_multiply, "__mul__", "__rmul__")
4136SLOT1BIN(slot_nb_divide, nb_divide, "__div__", "__rdiv__")
4137SLOT1BIN(slot_nb_remainder, nb_remainder, "__mod__", "__rmod__")
4138SLOT1BIN(slot_nb_divmod, nb_divmod, "__divmod__", "__rdivmod__")
4139
Jeremy Hylton938ace62002-07-17 16:30:39 +00004140static PyObject *slot_nb_power(PyObject *, PyObject *, PyObject *);
Guido van Rossumdc91b992001-08-08 22:26:22 +00004141
4142SLOT1BINFULL(slot_nb_power_binary, slot_nb_power,
4143 nb_power, "__pow__", "__rpow__")
4144
4145static PyObject *
4146slot_nb_power(PyObject *self, PyObject *other, PyObject *modulus)
4147{
Guido van Rossum2730b132001-08-28 18:22:14 +00004148 static PyObject *pow_str;
4149
Guido van Rossumdc91b992001-08-08 22:26:22 +00004150 if (modulus == Py_None)
4151 return slot_nb_power_binary(self, other);
Guido van Rossum23094982002-06-10 14:30:43 +00004152 /* Three-arg power doesn't use __rpow__. But ternary_op
4153 can call this when the second argument's type uses
4154 slot_nb_power, so check before calling self.__pow__. */
4155 if (self->ob_type->tp_as_number != NULL &&
4156 self->ob_type->tp_as_number->nb_power == slot_nb_power) {
4157 return call_method(self, "__pow__", &pow_str,
4158 "(OO)", other, modulus);
4159 }
4160 Py_INCREF(Py_NotImplemented);
4161 return Py_NotImplemented;
Guido van Rossumdc91b992001-08-08 22:26:22 +00004162}
4163
4164SLOT0(slot_nb_negative, "__neg__")
4165SLOT0(slot_nb_positive, "__pos__")
4166SLOT0(slot_nb_absolute, "__abs__")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004167
4168static int
4169slot_nb_nonzero(PyObject *self)
4170{
Tim Petersea7f75d2002-12-07 21:39:16 +00004171 PyObject *func, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00004172 static PyObject *nonzero_str, *len_str;
Tim Petersea7f75d2002-12-07 21:39:16 +00004173 int result = -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004174
Guido van Rossum55f20992001-10-01 17:18:22 +00004175 func = lookup_maybe(self, "__nonzero__", &nonzero_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004176 if (func == NULL) {
Guido van Rossum55f20992001-10-01 17:18:22 +00004177 if (PyErr_Occurred())
Guido van Rossumb8f63662001-08-15 23:57:02 +00004178 return -1;
Guido van Rossum55f20992001-10-01 17:18:22 +00004179 func = lookup_maybe(self, "__len__", &len_str);
Tim Petersea7f75d2002-12-07 21:39:16 +00004180 if (func == NULL)
4181 return PyErr_Occurred() ? -1 : 1;
4182 }
4183 args = PyTuple_New(0);
4184 if (args != NULL) {
4185 PyObject *temp = PyObject_Call(func, args, NULL);
4186 Py_DECREF(args);
4187 if (temp != NULL) {
4188 result = PyObject_IsTrue(temp);
4189 Py_DECREF(temp);
Guido van Rossum55f20992001-10-01 17:18:22 +00004190 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004191 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004192 Py_DECREF(func);
Tim Petersea7f75d2002-12-07 21:39:16 +00004193 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004194}
4195
Guido van Rossumdc91b992001-08-08 22:26:22 +00004196SLOT0(slot_nb_invert, "__invert__")
4197SLOT1BIN(slot_nb_lshift, nb_lshift, "__lshift__", "__rlshift__")
4198SLOT1BIN(slot_nb_rshift, nb_rshift, "__rshift__", "__rrshift__")
4199SLOT1BIN(slot_nb_and, nb_and, "__and__", "__rand__")
4200SLOT1BIN(slot_nb_xor, nb_xor, "__xor__", "__rxor__")
4201SLOT1BIN(slot_nb_or, nb_or, "__or__", "__ror__")
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004202
4203static int
4204slot_nb_coerce(PyObject **a, PyObject **b)
4205{
4206 static PyObject *coerce_str;
4207 PyObject *self = *a, *other = *b;
4208
4209 if (self->ob_type->tp_as_number != NULL &&
4210 self->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4211 PyObject *r;
4212 r = call_maybe(
4213 self, "__coerce__", &coerce_str, "(O)", other);
4214 if (r == NULL)
4215 return -1;
4216 if (r == Py_NotImplemented) {
4217 Py_DECREF(r);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004218 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004219 else {
4220 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4221 PyErr_SetString(PyExc_TypeError,
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004222 "__coerce__ didn't return a 2-tuple");
Guido van Rossum55f20992001-10-01 17:18:22 +00004223 Py_DECREF(r);
4224 return -1;
4225 }
4226 *a = PyTuple_GET_ITEM(r, 0);
4227 Py_INCREF(*a);
4228 *b = PyTuple_GET_ITEM(r, 1);
4229 Py_INCREF(*b);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004230 Py_DECREF(r);
Guido van Rossum55f20992001-10-01 17:18:22 +00004231 return 0;
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004232 }
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004233 }
4234 if (other->ob_type->tp_as_number != NULL &&
4235 other->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4236 PyObject *r;
4237 r = call_maybe(
4238 other, "__coerce__", &coerce_str, "(O)", self);
4239 if (r == NULL)
4240 return -1;
4241 if (r == Py_NotImplemented) {
4242 Py_DECREF(r);
4243 return 1;
4244 }
4245 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4246 PyErr_SetString(PyExc_TypeError,
4247 "__coerce__ didn't return a 2-tuple");
4248 Py_DECREF(r);
4249 return -1;
4250 }
4251 *a = PyTuple_GET_ITEM(r, 1);
4252 Py_INCREF(*a);
4253 *b = PyTuple_GET_ITEM(r, 0);
4254 Py_INCREF(*b);
4255 Py_DECREF(r);
4256 return 0;
4257 }
4258 return 1;
4259}
4260
Guido van Rossumdc91b992001-08-08 22:26:22 +00004261SLOT0(slot_nb_int, "__int__")
4262SLOT0(slot_nb_long, "__long__")
4263SLOT0(slot_nb_float, "__float__")
4264SLOT0(slot_nb_oct, "__oct__")
4265SLOT0(slot_nb_hex, "__hex__")
4266SLOT1(slot_nb_inplace_add, "__iadd__", PyObject *, "O")
4267SLOT1(slot_nb_inplace_subtract, "__isub__", PyObject *, "O")
4268SLOT1(slot_nb_inplace_multiply, "__imul__", PyObject *, "O")
4269SLOT1(slot_nb_inplace_divide, "__idiv__", PyObject *, "O")
4270SLOT1(slot_nb_inplace_remainder, "__imod__", PyObject *, "O")
Guido van Rossum6e5680f2002-10-15 01:01:53 +00004271SLOT1(slot_nb_inplace_power, "__ipow__", PyObject *, "O")
Guido van Rossumdc91b992001-08-08 22:26:22 +00004272SLOT1(slot_nb_inplace_lshift, "__ilshift__", PyObject *, "O")
4273SLOT1(slot_nb_inplace_rshift, "__irshift__", PyObject *, "O")
4274SLOT1(slot_nb_inplace_and, "__iand__", PyObject *, "O")
4275SLOT1(slot_nb_inplace_xor, "__ixor__", PyObject *, "O")
4276SLOT1(slot_nb_inplace_or, "__ior__", PyObject *, "O")
4277SLOT1BIN(slot_nb_floor_divide, nb_floor_divide,
4278 "__floordiv__", "__rfloordiv__")
4279SLOT1BIN(slot_nb_true_divide, nb_true_divide, "__truediv__", "__rtruediv__")
4280SLOT1(slot_nb_inplace_floor_divide, "__ifloordiv__", PyObject *, "O")
4281SLOT1(slot_nb_inplace_true_divide, "__itruediv__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004282
4283static int
Guido van Rossumb8f63662001-08-15 23:57:02 +00004284half_compare(PyObject *self, PyObject *other)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004285{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004286 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004287 static PyObject *cmp_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004288 int c;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004289
Guido van Rossum60718732001-08-28 17:47:51 +00004290 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004291 if (func == NULL) {
4292 PyErr_Clear();
4293 }
4294 else {
4295 args = Py_BuildValue("(O)", other);
4296 if (args == NULL)
4297 res = NULL;
4298 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004299 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004300 Py_DECREF(args);
4301 }
Raymond Hettingerab5dae32002-06-24 13:08:16 +00004302 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004303 if (res != Py_NotImplemented) {
4304 if (res == NULL)
4305 return -2;
4306 c = PyInt_AsLong(res);
4307 Py_DECREF(res);
4308 if (c == -1 && PyErr_Occurred())
4309 return -2;
4310 return (c < 0) ? -1 : (c > 0) ? 1 : 0;
4311 }
4312 Py_DECREF(res);
4313 }
4314 return 2;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004315}
4316
Guido van Rossumab3b0342001-09-18 20:38:53 +00004317/* This slot is published for the benefit of try_3way_compare in object.c */
4318int
4319_PyObject_SlotCompare(PyObject *self, PyObject *other)
Guido van Rossumb8f63662001-08-15 23:57:02 +00004320{
4321 int c;
4322
Guido van Rossumab3b0342001-09-18 20:38:53 +00004323 if (self->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004324 c = half_compare(self, other);
4325 if (c <= 1)
4326 return c;
4327 }
Guido van Rossumab3b0342001-09-18 20:38:53 +00004328 if (other->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004329 c = half_compare(other, self);
4330 if (c < -1)
4331 return -2;
4332 if (c <= 1)
4333 return -c;
4334 }
4335 return (void *)self < (void *)other ? -1 :
4336 (void *)self > (void *)other ? 1 : 0;
4337}
4338
4339static PyObject *
4340slot_tp_repr(PyObject *self)
4341{
4342 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004343 static PyObject *repr_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004344
Guido van Rossum60718732001-08-28 17:47:51 +00004345 func = lookup_method(self, "__repr__", &repr_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004346 if (func != NULL) {
4347 res = PyEval_CallObject(func, NULL);
4348 Py_DECREF(func);
4349 return res;
4350 }
Barry Warsaw7ce36942001-08-24 18:34:26 +00004351 PyErr_Clear();
4352 return PyString_FromFormat("<%s object at %p>",
4353 self->ob_type->tp_name, self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004354}
4355
4356static PyObject *
4357slot_tp_str(PyObject *self)
4358{
4359 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004360 static PyObject *str_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004361
Guido van Rossum60718732001-08-28 17:47:51 +00004362 func = lookup_method(self, "__str__", &str_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004363 if (func != NULL) {
4364 res = PyEval_CallObject(func, NULL);
4365 Py_DECREF(func);
4366 return res;
4367 }
4368 else {
4369 PyErr_Clear();
4370 return slot_tp_repr(self);
4371 }
4372}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004373
4374static long
4375slot_tp_hash(PyObject *self)
4376{
Tim Peters61ce0a92002-12-06 23:38:02 +00004377 PyObject *func;
Guido van Rossum60718732001-08-28 17:47:51 +00004378 static PyObject *hash_str, *eq_str, *cmp_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004379 long h;
4380
Guido van Rossum60718732001-08-28 17:47:51 +00004381 func = lookup_method(self, "__hash__", &hash_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004382
4383 if (func != NULL) {
Tim Peters61ce0a92002-12-06 23:38:02 +00004384 PyObject *res = PyEval_CallObject(func, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004385 Py_DECREF(func);
4386 if (res == NULL)
4387 return -1;
4388 h = PyInt_AsLong(res);
Tim Peters61ce0a92002-12-06 23:38:02 +00004389 Py_DECREF(res);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004390 }
4391 else {
4392 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004393 func = lookup_method(self, "__eq__", &eq_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004394 if (func == NULL) {
4395 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004396 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004397 }
4398 if (func != NULL) {
4399 Py_DECREF(func);
4400 PyErr_SetString(PyExc_TypeError, "unhashable type");
4401 return -1;
4402 }
4403 PyErr_Clear();
4404 h = _Py_HashPointer((void *)self);
4405 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004406 if (h == -1 && !PyErr_Occurred())
4407 h = -2;
4408 return h;
4409}
4410
4411static PyObject *
4412slot_tp_call(PyObject *self, PyObject *args, PyObject *kwds)
4413{
Guido van Rossum60718732001-08-28 17:47:51 +00004414 static PyObject *call_str;
4415 PyObject *meth = lookup_method(self, "__call__", &call_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004416 PyObject *res;
4417
4418 if (meth == NULL)
4419 return NULL;
4420 res = PyObject_Call(meth, args, kwds);
4421 Py_DECREF(meth);
4422 return res;
4423}
4424
Guido van Rossum14a6f832001-10-17 13:59:09 +00004425/* There are two slot dispatch functions for tp_getattro.
4426
4427 - slot_tp_getattro() is used when __getattribute__ is overridden
4428 but no __getattr__ hook is present;
4429
4430 - slot_tp_getattr_hook() is used when a __getattr__ hook is present.
4431
Guido van Rossumc334df52002-04-04 23:44:47 +00004432 The code in update_one_slot() always installs slot_tp_getattr_hook(); this
4433 detects the absence of __getattr__ and then installs the simpler slot if
4434 necessary. */
Guido van Rossum14a6f832001-10-17 13:59:09 +00004435
Tim Peters6d6c1a32001-08-02 04:15:00 +00004436static PyObject *
4437slot_tp_getattro(PyObject *self, PyObject *name)
4438{
Guido van Rossum14a6f832001-10-17 13:59:09 +00004439 static PyObject *getattribute_str = NULL;
4440 return call_method(self, "__getattribute__", &getattribute_str,
4441 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004442}
4443
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004444static PyObject *
4445slot_tp_getattr_hook(PyObject *self, PyObject *name)
4446{
4447 PyTypeObject *tp = self->ob_type;
4448 PyObject *getattr, *getattribute, *res;
4449 static PyObject *getattribute_str = NULL;
4450 static PyObject *getattr_str = NULL;
4451
4452 if (getattr_str == NULL) {
4453 getattr_str = PyString_InternFromString("__getattr__");
4454 if (getattr_str == NULL)
4455 return NULL;
4456 }
4457 if (getattribute_str == NULL) {
4458 getattribute_str =
4459 PyString_InternFromString("__getattribute__");
4460 if (getattribute_str == NULL)
4461 return NULL;
4462 }
4463 getattr = _PyType_Lookup(tp, getattr_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004464 if (getattr == NULL) {
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004465 /* No __getattr__ hook: use a simpler dispatcher */
4466 tp->tp_getattro = slot_tp_getattro;
4467 return slot_tp_getattro(self, name);
4468 }
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004469 getattribute = _PyType_Lookup(tp, getattribute_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004470 if (getattribute == NULL ||
4471 (getattribute->ob_type == &PyWrapperDescr_Type &&
4472 ((PyWrapperDescrObject *)getattribute)->d_wrapped ==
4473 (void *)PyObject_GenericGetAttr))
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004474 res = PyObject_GenericGetAttr(self, name);
4475 else
4476 res = PyObject_CallFunction(getattribute, "OO", self, name);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004477 if (res == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004478 PyErr_Clear();
4479 res = PyObject_CallFunction(getattr, "OO", self, name);
4480 }
4481 return res;
4482}
4483
Tim Peters6d6c1a32001-08-02 04:15:00 +00004484static int
4485slot_tp_setattro(PyObject *self, PyObject *name, PyObject *value)
4486{
4487 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004488 static PyObject *delattr_str, *setattr_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004489
4490 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004491 res = call_method(self, "__delattr__", &delattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004492 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004493 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004494 res = call_method(self, "__setattr__", &setattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004495 "(OO)", name, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004496 if (res == NULL)
4497 return -1;
4498 Py_DECREF(res);
4499 return 0;
4500}
4501
4502/* Map rich comparison operators to their __xx__ namesakes */
4503static char *name_op[] = {
4504 "__lt__",
4505 "__le__",
4506 "__eq__",
4507 "__ne__",
4508 "__gt__",
4509 "__ge__",
4510};
4511
4512static PyObject *
Guido van Rossumb8f63662001-08-15 23:57:02 +00004513half_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004514{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004515 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004516 static PyObject *op_str[6];
Tim Peters6d6c1a32001-08-02 04:15:00 +00004517
Guido van Rossum60718732001-08-28 17:47:51 +00004518 func = lookup_method(self, name_op[op], &op_str[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004519 if (func == NULL) {
4520 PyErr_Clear();
4521 Py_INCREF(Py_NotImplemented);
4522 return Py_NotImplemented;
4523 }
4524 args = Py_BuildValue("(O)", other);
4525 if (args == NULL)
4526 res = NULL;
4527 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004528 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004529 Py_DECREF(args);
4530 }
4531 Py_DECREF(func);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004532 return res;
4533}
4534
Guido van Rossumb8f63662001-08-15 23:57:02 +00004535/* Map rich comparison operators to their swapped version, e.g. LT --> GT */
4536static int swapped_op[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
4537
4538static PyObject *
4539slot_tp_richcompare(PyObject *self, PyObject *other, int op)
4540{
4541 PyObject *res;
4542
4543 if (self->ob_type->tp_richcompare == slot_tp_richcompare) {
4544 res = half_richcompare(self, other, op);
4545 if (res != Py_NotImplemented)
4546 return res;
4547 Py_DECREF(res);
4548 }
4549 if (other->ob_type->tp_richcompare == slot_tp_richcompare) {
4550 res = half_richcompare(other, self, swapped_op[op]);
4551 if (res != Py_NotImplemented) {
4552 return res;
4553 }
4554 Py_DECREF(res);
4555 }
4556 Py_INCREF(Py_NotImplemented);
4557 return Py_NotImplemented;
4558}
4559
4560static PyObject *
4561slot_tp_iter(PyObject *self)
4562{
4563 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004564 static PyObject *iter_str, *getitem_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004565
Guido van Rossum60718732001-08-28 17:47:51 +00004566 func = lookup_method(self, "__iter__", &iter_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004567 if (func != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +00004568 PyObject *args;
4569 args = res = PyTuple_New(0);
4570 if (args != NULL) {
4571 res = PyObject_Call(func, args, NULL);
4572 Py_DECREF(args);
4573 }
4574 Py_DECREF(func);
4575 return res;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004576 }
4577 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004578 func = lookup_method(self, "__getitem__", &getitem_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004579 if (func == NULL) {
Guido van Rossumd4641072002-04-03 02:13:37 +00004580 PyErr_SetString(PyExc_TypeError,
4581 "iteration over non-sequence");
Guido van Rossumb8f63662001-08-15 23:57:02 +00004582 return NULL;
4583 }
4584 Py_DECREF(func);
4585 return PySeqIter_New(self);
4586}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004587
4588static PyObject *
4589slot_tp_iternext(PyObject *self)
4590{
Guido van Rossum2730b132001-08-28 18:22:14 +00004591 static PyObject *next_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004592 return call_method(self, "next", &next_str, "()");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004593}
4594
Guido van Rossum1a493502001-08-17 16:47:50 +00004595static PyObject *
4596slot_tp_descr_get(PyObject *self, PyObject *obj, PyObject *type)
4597{
4598 PyTypeObject *tp = self->ob_type;
4599 PyObject *get;
4600 static PyObject *get_str = NULL;
4601
4602 if (get_str == NULL) {
4603 get_str = PyString_InternFromString("__get__");
4604 if (get_str == NULL)
4605 return NULL;
4606 }
4607 get = _PyType_Lookup(tp, get_str);
4608 if (get == NULL) {
4609 /* Avoid further slowdowns */
4610 if (tp->tp_descr_get == slot_tp_descr_get)
4611 tp->tp_descr_get = NULL;
4612 Py_INCREF(self);
4613 return self;
4614 }
Guido van Rossum2c252392001-08-24 10:13:31 +00004615 if (obj == NULL)
4616 obj = Py_None;
4617 if (type == NULL)
4618 type = Py_None;
Guido van Rossum1a493502001-08-17 16:47:50 +00004619 return PyObject_CallFunction(get, "OOO", self, obj, type);
4620}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004621
4622static int
4623slot_tp_descr_set(PyObject *self, PyObject *target, PyObject *value)
4624{
Guido van Rossum2c252392001-08-24 10:13:31 +00004625 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004626 static PyObject *del_str, *set_str;
Guido van Rossum2c252392001-08-24 10:13:31 +00004627
4628 if (value == NULL)
Guido van Rossum1d5b3f22001-12-03 00:08:33 +00004629 res = call_method(self, "__delete__", &del_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004630 "(O)", target);
Guido van Rossum2c252392001-08-24 10:13:31 +00004631 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004632 res = call_method(self, "__set__", &set_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004633 "(OO)", target, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004634 if (res == NULL)
4635 return -1;
4636 Py_DECREF(res);
4637 return 0;
4638}
4639
4640static int
4641slot_tp_init(PyObject *self, PyObject *args, PyObject *kwds)
4642{
Guido van Rossum60718732001-08-28 17:47:51 +00004643 static PyObject *init_str;
4644 PyObject *meth = lookup_method(self, "__init__", &init_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004645 PyObject *res;
4646
4647 if (meth == NULL)
4648 return -1;
4649 res = PyObject_Call(meth, args, kwds);
4650 Py_DECREF(meth);
4651 if (res == NULL)
4652 return -1;
4653 Py_DECREF(res);
4654 return 0;
4655}
4656
4657static PyObject *
4658slot_tp_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4659{
Guido van Rossum7bed2132002-08-08 21:57:53 +00004660 static PyObject *new_str;
4661 PyObject *func;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004662 PyObject *newargs, *x;
4663 int i, n;
4664
Guido van Rossum7bed2132002-08-08 21:57:53 +00004665 if (new_str == NULL) {
4666 new_str = PyString_InternFromString("__new__");
4667 if (new_str == NULL)
4668 return NULL;
4669 }
4670 func = PyObject_GetAttr((PyObject *)type, new_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004671 if (func == NULL)
4672 return NULL;
4673 assert(PyTuple_Check(args));
4674 n = PyTuple_GET_SIZE(args);
4675 newargs = PyTuple_New(n+1);
4676 if (newargs == NULL)
4677 return NULL;
4678 Py_INCREF(type);
4679 PyTuple_SET_ITEM(newargs, 0, (PyObject *)type);
4680 for (i = 0; i < n; i++) {
4681 x = PyTuple_GET_ITEM(args, i);
4682 Py_INCREF(x);
4683 PyTuple_SET_ITEM(newargs, i+1, x);
4684 }
4685 x = PyObject_Call(func, newargs, kwds);
Guido van Rossum25d18072001-10-01 15:55:28 +00004686 Py_DECREF(newargs);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004687 Py_DECREF(func);
4688 return x;
4689}
4690
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004691static void
4692slot_tp_del(PyObject *self)
4693{
4694 static PyObject *del_str = NULL;
4695 PyObject *del, *res;
4696 PyObject *error_type, *error_value, *error_traceback;
4697
4698 /* Temporarily resurrect the object. */
4699 assert(self->ob_refcnt == 0);
4700 self->ob_refcnt = 1;
4701
4702 /* Save the current exception, if any. */
4703 PyErr_Fetch(&error_type, &error_value, &error_traceback);
4704
4705 /* Execute __del__ method, if any. */
4706 del = lookup_maybe(self, "__del__", &del_str);
4707 if (del != NULL) {
4708 res = PyEval_CallObject(del, NULL);
4709 if (res == NULL)
4710 PyErr_WriteUnraisable(del);
4711 else
4712 Py_DECREF(res);
4713 Py_DECREF(del);
4714 }
4715
4716 /* Restore the saved exception. */
4717 PyErr_Restore(error_type, error_value, error_traceback);
4718
4719 /* Undo the temporary resurrection; can't use DECREF here, it would
4720 * cause a recursive call.
4721 */
4722 assert(self->ob_refcnt > 0);
4723 if (--self->ob_refcnt == 0)
4724 return; /* this is the normal path out */
4725
4726 /* __del__ resurrected it! Make it look like the original Py_DECREF
4727 * never happened.
4728 */
4729 {
4730 int refcnt = self->ob_refcnt;
4731 _Py_NewReference(self);
4732 self->ob_refcnt = refcnt;
4733 }
4734 assert(!PyType_IS_GC(self->ob_type) ||
4735 _Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
4736 /* If Py_REF_DEBUG, the original decref dropped _Py_RefTotal, but
4737 * _Py_NewReference bumped it again, so that's a wash.
4738 * If Py_TRACE_REFS, _Py_NewReference re-added self to the object
4739 * chain, so no more to do there either.
4740 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
4741 * _Py_NewReference bumped tp_allocs: both of those need to be
4742 * undone.
4743 */
4744#ifdef COUNT_ALLOCS
4745 --self->ob_type->tp_frees;
4746 --self->ob_type->tp_allocs;
4747#endif
4748}
4749
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004750
4751/* Table mapping __foo__ names to tp_foo offsets and slot_tp_foo wrapper
Tim Petersbf9b2442003-03-23 05:35:36 +00004752 functions. The offsets here are relative to the 'PyHeapTypeObject'
Guido van Rossume5c691a2003-03-07 15:13:17 +00004753 structure, which incorporates the additional structures used for numbers,
4754 sequences and mappings.
4755 Note that multiple names may map to the same slot (e.g. __eq__,
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004756 __ne__ etc. all map to tp_richcompare) and one name may map to multiple
Guido van Rossumc334df52002-04-04 23:44:47 +00004757 slots (e.g. __str__ affects tp_str as well as tp_repr). The table is
4758 terminated with an all-zero entry. (This table is further initialized and
4759 sorted in init_slotdefs() below.) */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004760
Guido van Rossum6d204072001-10-21 00:44:31 +00004761typedef struct wrapperbase slotdef;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004762
4763#undef TPSLOT
Guido van Rossumc8e56452001-10-22 00:43:43 +00004764#undef FLSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004765#undef ETSLOT
4766#undef SQSLOT
4767#undef MPSLOT
4768#undef NBSLOT
Guido van Rossum6d204072001-10-21 00:44:31 +00004769#undef UNSLOT
4770#undef IBSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004771#undef BINSLOT
4772#undef RBINSLOT
4773
Guido van Rossum6d204072001-10-21 00:44:31 +00004774#define TPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004775 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
4776 PyDoc_STR(DOC)}
Guido van Rossumc8e56452001-10-22 00:43:43 +00004777#define FLSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC, FLAGS) \
4778 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004779 PyDoc_STR(DOC), FLAGS}
Guido van Rossum6d204072001-10-21 00:44:31 +00004780#define ETSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Guido van Rossume5c691a2003-03-07 15:13:17 +00004781 {NAME, offsetof(PyHeapTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004782 PyDoc_STR(DOC)}
Guido van Rossum6d204072001-10-21 00:44:31 +00004783#define SQSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4784 ETSLOT(NAME, as_sequence.SLOT, FUNCTION, WRAPPER, DOC)
4785#define MPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4786 ETSLOT(NAME, as_mapping.SLOT, FUNCTION, WRAPPER, DOC)
4787#define NBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4788 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, DOC)
4789#define UNSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4790 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4791 "x." NAME "() <==> " DOC)
4792#define IBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4793 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4794 "x." NAME "(y) <==> x" DOC "y")
4795#define BINSLOT(NAME, SLOT, FUNCTION, DOC) \
4796 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
4797 "x." NAME "(y) <==> x" DOC "y")
4798#define RBINSLOT(NAME, SLOT, FUNCTION, DOC) \
4799 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
4800 "x." NAME "(y) <==> y" DOC "x")
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004801
4802static slotdef slotdefs[] = {
Guido van Rossum6d204072001-10-21 00:44:31 +00004803 SQSLOT("__len__", sq_length, slot_sq_length, wrap_inquiry,
4804 "x.__len__() <==> len(x)"),
4805 SQSLOT("__add__", sq_concat, slot_sq_concat, wrap_binaryfunc,
4806 "x.__add__(y) <==> x+y"),
4807 SQSLOT("__mul__", sq_repeat, slot_sq_repeat, wrap_intargfunc,
4808 "x.__mul__(n) <==> x*n"),
4809 SQSLOT("__rmul__", sq_repeat, slot_sq_repeat, wrap_intargfunc,
4810 "x.__rmul__(n) <==> n*x"),
4811 SQSLOT("__getitem__", sq_item, slot_sq_item, wrap_sq_item,
4812 "x.__getitem__(y) <==> x[y]"),
4813 SQSLOT("__getslice__", sq_slice, slot_sq_slice, wrap_intintargfunc,
Brett Cannon154da9b2003-05-20 02:30:04 +00004814 "x.__getslice__(i, j) <==> x[i:j]\n\
4815 \n\
4816 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004817 SQSLOT("__setitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_setitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00004818 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum6d204072001-10-21 00:44:31 +00004819 SQSLOT("__delitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00004820 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004821 SQSLOT("__setslice__", sq_ass_slice, slot_sq_ass_slice,
Guido van Rossum6d204072001-10-21 00:44:31 +00004822 wrap_intintobjargproc,
Brett Cannonbe67d872003-05-20 02:40:12 +00004823 "x.__setslice__(i, j, y) <==> x[i:j]=y\n\
4824 \n\
4825 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004826 SQSLOT("__delslice__", sq_ass_slice, slot_sq_ass_slice, wrap_delslice,
Brett Cannonbe67d872003-05-20 02:40:12 +00004827 "x.__delslice__(i, j) <==> del x[i:j]\n\
4828 \n\
4829 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004830 SQSLOT("__contains__", sq_contains, slot_sq_contains, wrap_objobjproc,
4831 "x.__contains__(y) <==> y in x"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004832 SQSLOT("__iadd__", sq_inplace_concat, slot_sq_inplace_concat,
Guido van Rossum6d204072001-10-21 00:44:31 +00004833 wrap_binaryfunc, "x.__iadd__(y) <==> x+=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004834 SQSLOT("__imul__", sq_inplace_repeat, slot_sq_inplace_repeat,
Guido van Rossum6d204072001-10-21 00:44:31 +00004835 wrap_intargfunc, "x.__imul__(y) <==> x*=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004836
Guido van Rossum6d204072001-10-21 00:44:31 +00004837 MPSLOT("__len__", mp_length, slot_mp_length, wrap_inquiry,
4838 "x.__len__() <==> len(x)"),
Guido van Rossumfd38f8e2001-10-09 20:17:57 +00004839 MPSLOT("__getitem__", mp_subscript, slot_mp_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004840 wrap_binaryfunc,
4841 "x.__getitem__(y) <==> x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004842 MPSLOT("__setitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004843 wrap_objobjargproc,
4844 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004845 MPSLOT("__delitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004846 wrap_delitem,
4847 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004848
Guido van Rossum6d204072001-10-21 00:44:31 +00004849 BINSLOT("__add__", nb_add, slot_nb_add,
4850 "+"),
4851 RBINSLOT("__radd__", nb_add, slot_nb_add,
4852 "+"),
4853 BINSLOT("__sub__", nb_subtract, slot_nb_subtract,
4854 "-"),
4855 RBINSLOT("__rsub__", nb_subtract, slot_nb_subtract,
4856 "-"),
4857 BINSLOT("__mul__", nb_multiply, slot_nb_multiply,
4858 "*"),
4859 RBINSLOT("__rmul__", nb_multiply, slot_nb_multiply,
4860 "*"),
4861 BINSLOT("__div__", nb_divide, slot_nb_divide,
4862 "/"),
4863 RBINSLOT("__rdiv__", nb_divide, slot_nb_divide,
4864 "/"),
4865 BINSLOT("__mod__", nb_remainder, slot_nb_remainder,
4866 "%"),
4867 RBINSLOT("__rmod__", nb_remainder, slot_nb_remainder,
4868 "%"),
4869 BINSLOT("__divmod__", nb_divmod, slot_nb_divmod,
4870 "divmod(x, y)"),
4871 RBINSLOT("__rdivmod__", nb_divmod, slot_nb_divmod,
4872 "divmod(y, x)"),
4873 NBSLOT("__pow__", nb_power, slot_nb_power, wrap_ternaryfunc,
4874 "x.__pow__(y[, z]) <==> pow(x, y[, z])"),
4875 NBSLOT("__rpow__", nb_power, slot_nb_power, wrap_ternaryfunc_r,
4876 "y.__rpow__(x[, z]) <==> pow(x, y[, z])"),
4877 UNSLOT("__neg__", nb_negative, slot_nb_negative, wrap_unaryfunc, "-x"),
4878 UNSLOT("__pos__", nb_positive, slot_nb_positive, wrap_unaryfunc, "+x"),
4879 UNSLOT("__abs__", nb_absolute, slot_nb_absolute, wrap_unaryfunc,
4880 "abs(x)"),
Guido van Rossumdfce3bf2002-03-10 14:11:16 +00004881 UNSLOT("__nonzero__", nb_nonzero, slot_nb_nonzero, wrap_inquiry,
Guido van Rossum6d204072001-10-21 00:44:31 +00004882 "x != 0"),
4883 UNSLOT("__invert__", nb_invert, slot_nb_invert, wrap_unaryfunc, "~x"),
4884 BINSLOT("__lshift__", nb_lshift, slot_nb_lshift, "<<"),
4885 RBINSLOT("__rlshift__", nb_lshift, slot_nb_lshift, "<<"),
4886 BINSLOT("__rshift__", nb_rshift, slot_nb_rshift, ">>"),
4887 RBINSLOT("__rrshift__", nb_rshift, slot_nb_rshift, ">>"),
4888 BINSLOT("__and__", nb_and, slot_nb_and, "&"),
4889 RBINSLOT("__rand__", nb_and, slot_nb_and, "&"),
4890 BINSLOT("__xor__", nb_xor, slot_nb_xor, "^"),
4891 RBINSLOT("__rxor__", nb_xor, slot_nb_xor, "^"),
4892 BINSLOT("__or__", nb_or, slot_nb_or, "|"),
4893 RBINSLOT("__ror__", nb_or, slot_nb_or, "|"),
4894 NBSLOT("__coerce__", nb_coerce, slot_nb_coerce, wrap_coercefunc,
4895 "x.__coerce__(y) <==> coerce(x, y)"),
4896 UNSLOT("__int__", nb_int, slot_nb_int, wrap_unaryfunc,
4897 "int(x)"),
4898 UNSLOT("__long__", nb_long, slot_nb_long, wrap_unaryfunc,
4899 "long(x)"),
4900 UNSLOT("__float__", nb_float, slot_nb_float, wrap_unaryfunc,
4901 "float(x)"),
4902 UNSLOT("__oct__", nb_oct, slot_nb_oct, wrap_unaryfunc,
4903 "oct(x)"),
4904 UNSLOT("__hex__", nb_hex, slot_nb_hex, wrap_unaryfunc,
4905 "hex(x)"),
4906 IBSLOT("__iadd__", nb_inplace_add, slot_nb_inplace_add,
4907 wrap_binaryfunc, "+"),
4908 IBSLOT("__isub__", nb_inplace_subtract, slot_nb_inplace_subtract,
4909 wrap_binaryfunc, "-"),
4910 IBSLOT("__imul__", nb_inplace_multiply, slot_nb_inplace_multiply,
4911 wrap_binaryfunc, "*"),
4912 IBSLOT("__idiv__", nb_inplace_divide, slot_nb_inplace_divide,
4913 wrap_binaryfunc, "/"),
4914 IBSLOT("__imod__", nb_inplace_remainder, slot_nb_inplace_remainder,
4915 wrap_binaryfunc, "%"),
4916 IBSLOT("__ipow__", nb_inplace_power, slot_nb_inplace_power,
Guido van Rossum6e5680f2002-10-15 01:01:53 +00004917 wrap_binaryfunc, "**"),
Guido van Rossum6d204072001-10-21 00:44:31 +00004918 IBSLOT("__ilshift__", nb_inplace_lshift, slot_nb_inplace_lshift,
4919 wrap_binaryfunc, "<<"),
4920 IBSLOT("__irshift__", nb_inplace_rshift, slot_nb_inplace_rshift,
4921 wrap_binaryfunc, ">>"),
4922 IBSLOT("__iand__", nb_inplace_and, slot_nb_inplace_and,
4923 wrap_binaryfunc, "&"),
4924 IBSLOT("__ixor__", nb_inplace_xor, slot_nb_inplace_xor,
4925 wrap_binaryfunc, "^"),
4926 IBSLOT("__ior__", nb_inplace_or, slot_nb_inplace_or,
4927 wrap_binaryfunc, "|"),
4928 BINSLOT("__floordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
4929 RBINSLOT("__rfloordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
4930 BINSLOT("__truediv__", nb_true_divide, slot_nb_true_divide, "/"),
4931 RBINSLOT("__rtruediv__", nb_true_divide, slot_nb_true_divide, "/"),
4932 IBSLOT("__ifloordiv__", nb_inplace_floor_divide,
4933 slot_nb_inplace_floor_divide, wrap_binaryfunc, "//"),
4934 IBSLOT("__itruediv__", nb_inplace_true_divide,
4935 slot_nb_inplace_true_divide, wrap_binaryfunc, "/"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004936
Guido van Rossum6d204072001-10-21 00:44:31 +00004937 TPSLOT("__str__", tp_str, slot_tp_str, wrap_unaryfunc,
4938 "x.__str__() <==> str(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00004939 TPSLOT("__str__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00004940 TPSLOT("__repr__", tp_repr, slot_tp_repr, wrap_unaryfunc,
4941 "x.__repr__() <==> repr(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00004942 TPSLOT("__repr__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00004943 TPSLOT("__cmp__", tp_compare, _PyObject_SlotCompare, wrap_cmpfunc,
4944 "x.__cmp__(y) <==> cmp(x,y)"),
4945 TPSLOT("__hash__", tp_hash, slot_tp_hash, wrap_hashfunc,
4946 "x.__hash__() <==> hash(x)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00004947 FLSLOT("__call__", tp_call, slot_tp_call, (wrapperfunc)wrap_call,
4948 "x.__call__(...) <==> x(...)", PyWrapperFlag_KEYWORDS),
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004949 TPSLOT("__getattribute__", tp_getattro, slot_tp_getattr_hook,
Guido van Rossum6d204072001-10-21 00:44:31 +00004950 wrap_binaryfunc, "x.__getattribute__('name') <==> x.name"),
4951 TPSLOT("__getattribute__", tp_getattr, NULL, NULL, ""),
4952 TPSLOT("__getattr__", tp_getattro, slot_tp_getattr_hook, NULL, ""),
4953 TPSLOT("__getattr__", tp_getattr, NULL, NULL, ""),
4954 TPSLOT("__setattr__", tp_setattro, slot_tp_setattro, wrap_setattr,
4955 "x.__setattr__('name', value) <==> x.name = value"),
4956 TPSLOT("__setattr__", tp_setattr, NULL, NULL, ""),
4957 TPSLOT("__delattr__", tp_setattro, slot_tp_setattro, wrap_delattr,
4958 "x.__delattr__('name') <==> del x.name"),
4959 TPSLOT("__delattr__", tp_setattr, NULL, NULL, ""),
4960 TPSLOT("__lt__", tp_richcompare, slot_tp_richcompare, richcmp_lt,
4961 "x.__lt__(y) <==> x<y"),
4962 TPSLOT("__le__", tp_richcompare, slot_tp_richcompare, richcmp_le,
4963 "x.__le__(y) <==> x<=y"),
4964 TPSLOT("__eq__", tp_richcompare, slot_tp_richcompare, richcmp_eq,
4965 "x.__eq__(y) <==> x==y"),
4966 TPSLOT("__ne__", tp_richcompare, slot_tp_richcompare, richcmp_ne,
4967 "x.__ne__(y) <==> x!=y"),
4968 TPSLOT("__gt__", tp_richcompare, slot_tp_richcompare, richcmp_gt,
4969 "x.__gt__(y) <==> x>y"),
4970 TPSLOT("__ge__", tp_richcompare, slot_tp_richcompare, richcmp_ge,
4971 "x.__ge__(y) <==> x>=y"),
4972 TPSLOT("__iter__", tp_iter, slot_tp_iter, wrap_unaryfunc,
4973 "x.__iter__() <==> iter(x)"),
4974 TPSLOT("next", tp_iternext, slot_tp_iternext, wrap_next,
4975 "x.next() -> the next value, or raise StopIteration"),
4976 TPSLOT("__get__", tp_descr_get, slot_tp_descr_get, wrap_descr_get,
4977 "descr.__get__(obj[, type]) -> value"),
4978 TPSLOT("__set__", tp_descr_set, slot_tp_descr_set, wrap_descr_set,
4979 "descr.__set__(obj, value)"),
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00004980 TPSLOT("__delete__", tp_descr_set, slot_tp_descr_set,
4981 wrap_descr_delete, "descr.__delete__(obj)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00004982 FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
Guido van Rossum6d204072001-10-21 00:44:31 +00004983 "x.__init__(...) initializes x; "
Guido van Rossumc8e56452001-10-22 00:43:43 +00004984 "see x.__class__.__doc__ for signature",
4985 PyWrapperFlag_KEYWORDS),
4986 TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004987 TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004988 {NULL}
4989};
4990
Guido van Rossumc334df52002-04-04 23:44:47 +00004991/* Given a type pointer and an offset gotten from a slotdef entry, return a
4992 pointer to the actual slot. This is not quite the same as simply adding
4993 the offset to the type pointer, since it takes care to indirect through the
4994 proper indirection pointer (as_buffer, etc.); it returns NULL if the
4995 indirection pointer is NULL. */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004996static void **
4997slotptr(PyTypeObject *type, int offset)
4998{
4999 char *ptr;
5000
Guido van Rossume5c691a2003-03-07 15:13:17 +00005001 /* Note: this depends on the order of the members of PyHeapTypeObject! */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005002 assert(offset >= 0);
Guido van Rossume5c691a2003-03-07 15:13:17 +00005003 assert(offset < offsetof(PyHeapTypeObject, as_buffer));
5004 if (offset >= offsetof(PyHeapTypeObject, as_sequence)) {
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005005 ptr = (void *)type->tp_as_sequence;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005006 offset -= offsetof(PyHeapTypeObject, as_sequence);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005007 }
Guido van Rossume5c691a2003-03-07 15:13:17 +00005008 else if (offset >= offsetof(PyHeapTypeObject, as_mapping)) {
Guido van Rossum09638c12002-06-13 19:17:46 +00005009 ptr = (void *)type->tp_as_mapping;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005010 offset -= offsetof(PyHeapTypeObject, as_mapping);
Guido van Rossum09638c12002-06-13 19:17:46 +00005011 }
Guido van Rossume5c691a2003-03-07 15:13:17 +00005012 else if (offset >= offsetof(PyHeapTypeObject, as_number)) {
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005013 ptr = (void *)type->tp_as_number;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005014 offset -= offsetof(PyHeapTypeObject, as_number);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005015 }
5016 else {
5017 ptr = (void *)type;
5018 }
5019 if (ptr != NULL)
5020 ptr += offset;
5021 return (void **)ptr;
5022}
Guido van Rossumf040ede2001-08-07 16:40:56 +00005023
Guido van Rossumc334df52002-04-04 23:44:47 +00005024/* Length of array of slotdef pointers used to store slots with the
5025 same __name__. There should be at most MAX_EQUIV-1 slotdef entries with
5026 the same __name__, for any __name__. Since that's a static property, it is
5027 appropriate to declare fixed-size arrays for this. */
5028#define MAX_EQUIV 10
5029
5030/* Return a slot pointer for a given name, but ONLY if the attribute has
5031 exactly one slot function. The name must be an interned string. */
5032static void **
5033resolve_slotdups(PyTypeObject *type, PyObject *name)
5034{
5035 /* XXX Maybe this could be optimized more -- but is it worth it? */
5036
5037 /* pname and ptrs act as a little cache */
5038 static PyObject *pname;
5039 static slotdef *ptrs[MAX_EQUIV];
5040 slotdef *p, **pp;
5041 void **res, **ptr;
5042
5043 if (pname != name) {
5044 /* Collect all slotdefs that match name into ptrs. */
5045 pname = name;
5046 pp = ptrs;
5047 for (p = slotdefs; p->name_strobj; p++) {
5048 if (p->name_strobj == name)
5049 *pp++ = p;
5050 }
5051 *pp = NULL;
5052 }
5053
5054 /* Look in all matching slots of the type; if exactly one of these has
5055 a filled-in slot, return its value. Otherwise return NULL. */
5056 res = NULL;
5057 for (pp = ptrs; *pp; pp++) {
5058 ptr = slotptr(type, (*pp)->offset);
5059 if (ptr == NULL || *ptr == NULL)
5060 continue;
5061 if (res != NULL)
5062 return NULL;
5063 res = ptr;
5064 }
5065 return res;
5066}
5067
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005068/* Common code for update_slots_callback() and fixup_slot_dispatchers(). This
Guido van Rossumc334df52002-04-04 23:44:47 +00005069 does some incredibly complex thinking and then sticks something into the
5070 slot. (It sees if the adjacent slotdefs for the same slot have conflicting
5071 interests, and then stores a generic wrapper or a specific function into
5072 the slot.) Return a pointer to the next slotdef with a different offset,
5073 because that's convenient for fixup_slot_dispatchers(). */
5074static slotdef *
5075update_one_slot(PyTypeObject *type, slotdef *p)
5076{
5077 PyObject *descr;
5078 PyWrapperDescrObject *d;
5079 void *generic = NULL, *specific = NULL;
5080 int use_generic = 0;
5081 int offset = p->offset;
5082 void **ptr = slotptr(type, offset);
5083
5084 if (ptr == NULL) {
5085 do {
5086 ++p;
5087 } while (p->offset == offset);
5088 return p;
5089 }
5090 do {
5091 descr = _PyType_Lookup(type, p->name_strobj);
5092 if (descr == NULL)
5093 continue;
5094 if (descr->ob_type == &PyWrapperDescr_Type) {
5095 void **tptr = resolve_slotdups(type, p->name_strobj);
5096 if (tptr == NULL || tptr == ptr)
5097 generic = p->function;
5098 d = (PyWrapperDescrObject *)descr;
5099 if (d->d_base->wrapper == p->wrapper &&
5100 PyType_IsSubtype(type, d->d_type))
5101 {
5102 if (specific == NULL ||
5103 specific == d->d_wrapped)
5104 specific = d->d_wrapped;
5105 else
5106 use_generic = 1;
5107 }
5108 }
Guido van Rossum721f62e2002-08-09 02:14:34 +00005109 else if (descr->ob_type == &PyCFunction_Type &&
5110 PyCFunction_GET_FUNCTION(descr) ==
5111 (PyCFunction)tp_new_wrapper &&
5112 strcmp(p->name, "__new__") == 0)
5113 {
5114 /* The __new__ wrapper is not a wrapper descriptor,
5115 so must be special-cased differently.
5116 If we don't do this, creating an instance will
5117 always use slot_tp_new which will look up
5118 __new__ in the MRO which will call tp_new_wrapper
5119 which will look through the base classes looking
5120 for a static base and call its tp_new (usually
5121 PyType_GenericNew), after performing various
5122 sanity checks and constructing a new argument
5123 list. Cut all that nonsense short -- this speeds
5124 up instance creation tremendously. */
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005125 specific = (void *)type->tp_new;
Guido van Rossum721f62e2002-08-09 02:14:34 +00005126 /* XXX I'm not 100% sure that there isn't a hole
5127 in this reasoning that requires additional
5128 sanity checks. I'll buy the first person to
5129 point out a bug in this reasoning a beer. */
5130 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005131 else {
5132 use_generic = 1;
5133 generic = p->function;
5134 }
5135 } while ((++p)->offset == offset);
5136 if (specific && !use_generic)
5137 *ptr = specific;
5138 else
5139 *ptr = generic;
5140 return p;
5141}
5142
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005143/* In the type, update the slots whose slotdefs are gathered in the pp array.
5144 This is a callback for update_subclasses(). */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005145static int
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005146update_slots_callback(PyTypeObject *type, void *data)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005147{
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005148 slotdef **pp = (slotdef **)data;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005149
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005150 for (; *pp; pp++)
Guido van Rossumc334df52002-04-04 23:44:47 +00005151 update_one_slot(type, *pp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005152 return 0;
5153}
5154
Guido van Rossumc334df52002-04-04 23:44:47 +00005155/* Comparison function for qsort() to compare slotdefs by their offset, and
5156 for equal offset by their address (to force a stable sort). */
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005157static int
5158slotdef_cmp(const void *aa, const void *bb)
5159{
5160 const slotdef *a = (const slotdef *)aa, *b = (const slotdef *)bb;
5161 int c = a->offset - b->offset;
5162 if (c != 0)
5163 return c;
5164 else
5165 return a - b;
5166}
5167
Guido van Rossumc334df52002-04-04 23:44:47 +00005168/* Initialize the slotdefs table by adding interned string objects for the
5169 names and sorting the entries. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005170static void
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005171init_slotdefs(void)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005172{
5173 slotdef *p;
5174 static int initialized = 0;
5175
5176 if (initialized)
5177 return;
5178 for (p = slotdefs; p->name; p++) {
5179 p->name_strobj = PyString_InternFromString(p->name);
5180 if (!p->name_strobj)
Guido van Rossumc334df52002-04-04 23:44:47 +00005181 Py_FatalError("Out of memory interning slotdef names");
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005182 }
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005183 qsort((void *)slotdefs, (size_t)(p-slotdefs), sizeof(slotdef),
5184 slotdef_cmp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005185 initialized = 1;
5186}
5187
Guido van Rossumc334df52002-04-04 23:44:47 +00005188/* Update the slots after assignment to a class (type) attribute. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005189static int
5190update_slot(PyTypeObject *type, PyObject *name)
5191{
Guido van Rossumc334df52002-04-04 23:44:47 +00005192 slotdef *ptrs[MAX_EQUIV];
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005193 slotdef *p;
5194 slotdef **pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005195 int offset;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005196
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005197 init_slotdefs();
5198 pp = ptrs;
5199 for (p = slotdefs; p->name; p++) {
5200 /* XXX assume name is interned! */
5201 if (p->name_strobj == name)
5202 *pp++ = p;
5203 }
5204 *pp = NULL;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005205 for (pp = ptrs; *pp; pp++) {
5206 p = *pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005207 offset = p->offset;
5208 while (p > slotdefs && (p-1)->offset == offset)
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005209 --p;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005210 *pp = p;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005211 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005212 if (ptrs[0] == NULL)
5213 return 0; /* Not an attribute that affects any slots */
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005214 return update_subclasses(type, name,
5215 update_slots_callback, (void *)ptrs);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005216}
5217
Guido van Rossumc334df52002-04-04 23:44:47 +00005218/* Store the proper functions in the slot dispatches at class (type)
5219 definition time, based upon which operations the class overrides in its
5220 dict. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00005221static void
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005222fixup_slot_dispatchers(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005223{
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005224 slotdef *p;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005225
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005226 init_slotdefs();
Guido van Rossumc334df52002-04-04 23:44:47 +00005227 for (p = slotdefs; p->name; )
5228 p = update_one_slot(type, p);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005229}
Guido van Rossum705f0f52001-08-24 16:47:00 +00005230
Michael W. Hudson98bbc492002-11-26 14:47:27 +00005231static void
5232update_all_slots(PyTypeObject* type)
5233{
5234 slotdef *p;
5235
5236 init_slotdefs();
5237 for (p = slotdefs; p->name; p++) {
5238 /* update_slot returns int but can't actually fail */
5239 update_slot(type, p->name_strobj);
5240 }
5241}
5242
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005243/* recurse_down_subclasses() and update_subclasses() are mutually
5244 recursive functions to call a callback for all subclasses,
5245 but refraining from recursing into subclasses that define 'name'. */
5246
5247static int
5248update_subclasses(PyTypeObject *type, PyObject *name,
5249 update_callback callback, void *data)
5250{
5251 if (callback(type, data) < 0)
5252 return -1;
5253 return recurse_down_subclasses(type, name, callback, data);
5254}
5255
5256static int
5257recurse_down_subclasses(PyTypeObject *type, PyObject *name,
5258 update_callback callback, void *data)
5259{
5260 PyTypeObject *subclass;
5261 PyObject *ref, *subclasses, *dict;
5262 int i, n;
5263
5264 subclasses = type->tp_subclasses;
5265 if (subclasses == NULL)
5266 return 0;
5267 assert(PyList_Check(subclasses));
5268 n = PyList_GET_SIZE(subclasses);
5269 for (i = 0; i < n; i++) {
5270 ref = PyList_GET_ITEM(subclasses, i);
5271 assert(PyWeakref_CheckRef(ref));
5272 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
5273 assert(subclass != NULL);
5274 if ((PyObject *)subclass == Py_None)
5275 continue;
5276 assert(PyType_Check(subclass));
5277 /* Avoid recursing down into unaffected classes */
5278 dict = subclass->tp_dict;
5279 if (dict != NULL && PyDict_Check(dict) &&
5280 PyDict_GetItem(dict, name) != NULL)
5281 continue;
5282 if (update_subclasses(subclass, name, callback, data) < 0)
5283 return -1;
5284 }
5285 return 0;
5286}
5287
Guido van Rossum6d204072001-10-21 00:44:31 +00005288/* This function is called by PyType_Ready() to populate the type's
5289 dictionary with method descriptors for function slots. For each
Guido van Rossum09638c12002-06-13 19:17:46 +00005290 function slot (like tp_repr) that's defined in the type, one or more
5291 corresponding descriptors are added in the type's tp_dict dictionary
5292 under the appropriate name (like __repr__). Some function slots
5293 cause more than one descriptor to be added (for example, the nb_add
5294 slot adds both __add__ and __radd__ descriptors) and some function
5295 slots compete for the same descriptor (for example both sq_item and
5296 mp_subscript generate a __getitem__ descriptor).
5297
5298 In the latter case, the first slotdef entry encoutered wins. Since
Tim Petersbf9b2442003-03-23 05:35:36 +00005299 slotdef entries are sorted by the offset of the slot in the
Guido van Rossume5c691a2003-03-07 15:13:17 +00005300 PyHeapTypeObject, this gives us some control over disambiguating
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005301 between competing slots: the members of PyHeapTypeObject are listed
5302 from most general to least general, so the most general slot is
5303 preferred. In particular, because as_mapping comes before as_sequence,
5304 for a type that defines both mp_subscript and sq_item, mp_subscript
5305 wins.
Guido van Rossum09638c12002-06-13 19:17:46 +00005306
5307 This only adds new descriptors and doesn't overwrite entries in
5308 tp_dict that were previously defined. The descriptors contain a
5309 reference to the C function they must call, so that it's safe if they
5310 are copied into a subtype's __dict__ and the subtype has a different
5311 C function in its slot -- calling the method defined by the
5312 descriptor will call the C function that was used to create it,
5313 rather than the C function present in the slot when it is called.
5314 (This is important because a subtype may have a C function in the
5315 slot that calls the method from the dictionary, and we want to avoid
5316 infinite recursion here.) */
Guido van Rossum6d204072001-10-21 00:44:31 +00005317
5318static int
5319add_operators(PyTypeObject *type)
5320{
5321 PyObject *dict = type->tp_dict;
5322 slotdef *p;
5323 PyObject *descr;
5324 void **ptr;
5325
5326 init_slotdefs();
5327 for (p = slotdefs; p->name; p++) {
5328 if (p->wrapper == NULL)
5329 continue;
5330 ptr = slotptr(type, p->offset);
5331 if (!ptr || !*ptr)
5332 continue;
5333 if (PyDict_GetItem(dict, p->name_strobj))
5334 continue;
5335 descr = PyDescr_NewWrapper(type, p, *ptr);
5336 if (descr == NULL)
5337 return -1;
5338 if (PyDict_SetItem(dict, p->name_strobj, descr) < 0)
5339 return -1;
5340 Py_DECREF(descr);
5341 }
5342 if (type->tp_new != NULL) {
5343 if (add_tp_new_wrapper(type) < 0)
5344 return -1;
5345 }
5346 return 0;
5347}
5348
Guido van Rossum705f0f52001-08-24 16:47:00 +00005349
5350/* Cooperative 'super' */
5351
5352typedef struct {
5353 PyObject_HEAD
Guido van Rossume705ef12001-08-29 15:47:06 +00005354 PyTypeObject *type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005355 PyObject *obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005356 PyTypeObject *obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005357} superobject;
5358
Guido van Rossum6f799372001-09-20 20:46:19 +00005359static PyMemberDef super_members[] = {
5360 {"__thisclass__", T_OBJECT, offsetof(superobject, type), READONLY,
5361 "the class invoking super()"},
5362 {"__self__", T_OBJECT, offsetof(superobject, obj), READONLY,
5363 "the instance invoking super(); may be None"},
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005364 {"__self_class__", T_OBJECT, offsetof(superobject, obj_type), READONLY,
5365 "the type of the the instance invoking super(); may be None"},
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005366 {0}
5367};
5368
Guido van Rossum705f0f52001-08-24 16:47:00 +00005369static void
5370super_dealloc(PyObject *self)
5371{
5372 superobject *su = (superobject *)self;
5373
Guido van Rossum048eb752001-10-02 21:24:57 +00005374 _PyObject_GC_UNTRACK(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005375 Py_XDECREF(su->obj);
5376 Py_XDECREF(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005377 Py_XDECREF(su->obj_type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005378 self->ob_type->tp_free(self);
5379}
5380
5381static PyObject *
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005382super_repr(PyObject *self)
5383{
5384 superobject *su = (superobject *)self;
5385
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005386 if (su->obj_type)
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005387 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005388 "<super: <class '%s'>, <%s object>>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005389 su->type ? su->type->tp_name : "NULL",
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005390 su->obj_type->tp_name);
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005391 else
5392 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005393 "<super: <class '%s'>, NULL>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005394 su->type ? su->type->tp_name : "NULL");
5395}
5396
5397static PyObject *
Guido van Rossum705f0f52001-08-24 16:47:00 +00005398super_getattro(PyObject *self, PyObject *name)
5399{
5400 superobject *su = (superobject *)self;
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005401 int skip = su->obj_type == NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005402
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005403 if (!skip) {
5404 /* We want __class__ to return the class of the super object
5405 (i.e. super, or a subclass), not the class of su->obj. */
5406 skip = (PyString_Check(name) &&
5407 PyString_GET_SIZE(name) == 9 &&
5408 strcmp(PyString_AS_STRING(name), "__class__") == 0);
5409 }
5410
5411 if (!skip) {
Tim Petersa91e9642001-11-14 23:32:33 +00005412 PyObject *mro, *res, *tmp, *dict;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005413 PyTypeObject *starttype;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005414 descrgetfunc f;
5415 int i, n;
5416
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005417 starttype = su->obj_type;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005418 mro = starttype->tp_mro;
5419
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005420 if (mro == NULL)
5421 n = 0;
5422 else {
5423 assert(PyTuple_Check(mro));
5424 n = PyTuple_GET_SIZE(mro);
5425 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005426 for (i = 0; i < n; i++) {
Guido van Rossume705ef12001-08-29 15:47:06 +00005427 if ((PyObject *)(su->type) == PyTuple_GET_ITEM(mro, i))
Guido van Rossum705f0f52001-08-24 16:47:00 +00005428 break;
5429 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005430 i++;
5431 res = NULL;
5432 for (; i < n; i++) {
5433 tmp = PyTuple_GET_ITEM(mro, i);
Tim Petersa91e9642001-11-14 23:32:33 +00005434 if (PyType_Check(tmp))
5435 dict = ((PyTypeObject *)tmp)->tp_dict;
5436 else if (PyClass_Check(tmp))
5437 dict = ((PyClassObject *)tmp)->cl_dict;
5438 else
5439 continue;
5440 res = PyDict_GetItem(dict, name);
Guido van Rossum6cc5bb62003-04-16 20:01:36 +00005441 if (res != NULL) {
Guido van Rossum705f0f52001-08-24 16:47:00 +00005442 Py_INCREF(res);
5443 f = res->ob_type->tp_descr_get;
5444 if (f != NULL) {
Guido van Rossumd4641072002-04-03 02:13:37 +00005445 tmp = f(res, su->obj,
5446 (PyObject *)starttype);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005447 Py_DECREF(res);
5448 res = tmp;
5449 }
5450 return res;
5451 }
5452 }
5453 }
5454 return PyObject_GenericGetAttr(self, name);
5455}
5456
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005457static PyTypeObject *
Guido van Rossum5b443c62001-12-03 15:38:28 +00005458supercheck(PyTypeObject *type, PyObject *obj)
5459{
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005460 /* Check that a super() call makes sense. Return a type object.
5461
5462 obj can be a new-style class, or an instance of one:
5463
5464 - If it is a class, it must be a subclass of 'type'. This case is
5465 used for class methods; the return value is obj.
5466
5467 - If it is an instance, it must be an instance of 'type'. This is
5468 the normal case; the return value is obj.__class__.
5469
5470 But... when obj is an instance, we want to allow for the case where
5471 obj->ob_type is not a subclass of type, but obj.__class__ is!
5472 This will allow using super() with a proxy for obj.
5473 */
5474
Guido van Rossum8e80a722003-02-18 19:22:22 +00005475 /* Check for first bullet above (special case) */
5476 if (PyType_Check(obj) && PyType_IsSubtype((PyTypeObject *)obj, type)) {
5477 Py_INCREF(obj);
5478 return (PyTypeObject *)obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005479 }
Guido van Rossum8e80a722003-02-18 19:22:22 +00005480
5481 /* Normal case */
5482 if (PyType_IsSubtype(obj->ob_type, type)) {
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005483 Py_INCREF(obj->ob_type);
5484 return obj->ob_type;
5485 }
5486 else {
5487 /* Try the slow way */
5488 static PyObject *class_str = NULL;
5489 PyObject *class_attr;
5490
5491 if (class_str == NULL) {
5492 class_str = PyString_FromString("__class__");
5493 if (class_str == NULL)
5494 return NULL;
5495 }
5496
5497 class_attr = PyObject_GetAttr(obj, class_str);
5498
5499 if (class_attr != NULL &&
5500 PyType_Check(class_attr) &&
5501 (PyTypeObject *)class_attr != obj->ob_type)
5502 {
5503 int ok = PyType_IsSubtype(
5504 (PyTypeObject *)class_attr, type);
5505 if (ok)
5506 return (PyTypeObject *)class_attr;
5507 }
5508
5509 if (class_attr == NULL)
5510 PyErr_Clear();
5511 else
5512 Py_DECREF(class_attr);
5513 }
5514
Tim Peters97e5ff52003-02-18 19:32:50 +00005515 PyErr_SetString(PyExc_TypeError,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005516 "super(type, obj): "
5517 "obj must be an instance or subtype of type");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005518 return NULL;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005519}
5520
Guido van Rossum705f0f52001-08-24 16:47:00 +00005521static PyObject *
5522super_descr_get(PyObject *self, PyObject *obj, PyObject *type)
5523{
5524 superobject *su = (superobject *)self;
5525 superobject *new;
5526
5527 if (obj == NULL || obj == Py_None || su->obj != NULL) {
5528 /* Not binding to an object, or already bound */
5529 Py_INCREF(self);
5530 return self;
5531 }
Guido van Rossum5b443c62001-12-03 15:38:28 +00005532 if (su->ob_type != &PySuper_Type)
5533 /* If su is an instance of a subclass of super,
5534 call its type */
5535 return PyObject_CallFunction((PyObject *)su->ob_type,
5536 "OO", su->type, obj);
5537 else {
5538 /* Inline the common case */
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005539 PyTypeObject *obj_type = supercheck(su->type, obj);
5540 if (obj_type == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00005541 return NULL;
5542 new = (superobject *)PySuper_Type.tp_new(&PySuper_Type,
5543 NULL, NULL);
5544 if (new == NULL)
5545 return NULL;
5546 Py_INCREF(su->type);
5547 Py_INCREF(obj);
5548 new->type = su->type;
5549 new->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005550 new->obj_type = obj_type;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005551 return (PyObject *)new;
5552 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005553}
5554
5555static int
5556super_init(PyObject *self, PyObject *args, PyObject *kwds)
5557{
5558 superobject *su = (superobject *)self;
Guido van Rossume705ef12001-08-29 15:47:06 +00005559 PyTypeObject *type;
5560 PyObject *obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005561 PyTypeObject *obj_type = NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005562
5563 if (!PyArg_ParseTuple(args, "O!|O:super", &PyType_Type, &type, &obj))
5564 return -1;
5565 if (obj == Py_None)
5566 obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005567 if (obj != NULL) {
5568 obj_type = supercheck(type, obj);
5569 if (obj_type == NULL)
5570 return -1;
5571 Py_INCREF(obj);
5572 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005573 Py_INCREF(type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005574 su->type = type;
5575 su->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005576 su->obj_type = obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005577 return 0;
5578}
5579
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005580PyDoc_STRVAR(super_doc,
Guido van Rossum705f0f52001-08-24 16:47:00 +00005581"super(type) -> unbound super object\n"
5582"super(type, obj) -> bound super object; requires isinstance(obj, type)\n"
Guido van Rossume705ef12001-08-29 15:47:06 +00005583"super(type, type2) -> bound super object; requires issubclass(type2, type)\n"
Guido van Rossum705f0f52001-08-24 16:47:00 +00005584"Typical use to call a cooperative superclass method:\n"
5585"class C(B):\n"
5586" def meth(self, arg):\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005587" super(C, self).meth(arg)");
Guido van Rossum705f0f52001-08-24 16:47:00 +00005588
Guido van Rossum048eb752001-10-02 21:24:57 +00005589static int
5590super_traverse(PyObject *self, visitproc visit, void *arg)
5591{
5592 superobject *su = (superobject *)self;
5593 int err;
5594
5595#define VISIT(SLOT) \
5596 if (SLOT) { \
5597 err = visit((PyObject *)(SLOT), arg); \
5598 if (err) \
5599 return err; \
5600 }
5601
5602 VISIT(su->obj);
5603 VISIT(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005604 VISIT(su->obj_type);
Guido van Rossum048eb752001-10-02 21:24:57 +00005605
5606#undef VISIT
5607
5608 return 0;
5609}
5610
Guido van Rossum705f0f52001-08-24 16:47:00 +00005611PyTypeObject PySuper_Type = {
5612 PyObject_HEAD_INIT(&PyType_Type)
5613 0, /* ob_size */
5614 "super", /* tp_name */
5615 sizeof(superobject), /* tp_basicsize */
5616 0, /* tp_itemsize */
5617 /* methods */
5618 super_dealloc, /* tp_dealloc */
5619 0, /* tp_print */
5620 0, /* tp_getattr */
5621 0, /* tp_setattr */
5622 0, /* tp_compare */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005623 super_repr, /* tp_repr */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005624 0, /* tp_as_number */
5625 0, /* tp_as_sequence */
5626 0, /* tp_as_mapping */
5627 0, /* tp_hash */
5628 0, /* tp_call */
5629 0, /* tp_str */
5630 super_getattro, /* tp_getattro */
5631 0, /* tp_setattro */
5632 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00005633 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
5634 Py_TPFLAGS_BASETYPE, /* tp_flags */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005635 super_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00005636 super_traverse, /* tp_traverse */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005637 0, /* tp_clear */
5638 0, /* tp_richcompare */
5639 0, /* tp_weaklistoffset */
5640 0, /* tp_iter */
5641 0, /* tp_iternext */
5642 0, /* tp_methods */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005643 super_members, /* tp_members */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005644 0, /* tp_getset */
5645 0, /* tp_base */
5646 0, /* tp_dict */
5647 super_descr_get, /* tp_descr_get */
5648 0, /* tp_descr_set */
5649 0, /* tp_dictoffset */
5650 super_init, /* tp_init */
5651 PyType_GenericAlloc, /* tp_alloc */
5652 PyType_GenericNew, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00005653 PyObject_GC_Del, /* tp_free */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005654};