blob: d963fe13bbb9e7982dd7ceb257f3611d4ea0fa67 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Class object implementation */
3
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Guido van Rossum3f5da241990-12-20 15:06:42 +00005#include "structmember.h"
Guido van Rossum04691fc1992-08-12 15:35:34 +00006
Guido van Rossum52ca98a1994-09-05 07:32:29 +00007/* Forward */
Tim Petersdbd9ba62000-07-09 03:09:57 +00008static PyObject *class_lookup(PyClassObject *, PyObject *,
9 PyClassObject **);
10static PyObject *instance_getattr1(PyInstanceObject *, PyObject *);
11static PyObject *instance_getattr2(PyInstanceObject *, PyObject *);
Guido van Rossum52ca98a1994-09-05 07:32:29 +000012
Guido van Rossuma63eff61998-05-29 21:37:21 +000013static PyObject *getattrstr, *setattrstr, *delattrstr;
14
Fred Drake79912472000-07-09 04:06:11 +000015
Guido van Rossumc0b618a1997-05-02 03:12:38 +000016PyObject *
Fred Drake79912472000-07-09 04:06:11 +000017PyClass_New(PyObject *bases, PyObject *dict, PyObject *name)
18 /* bases is NULL or tuple of classobjects! */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000019{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000020 PyClassObject *op, *dummy;
Guido van Rossum7cc56eb1997-09-12 20:04:46 +000021 static PyObject *docstr, *modstr, *namestr;
Guido van Rossum019f4241996-08-21 14:54:28 +000022 if (docstr == NULL) {
Guido van Rossuma412d241997-01-18 07:59:12 +000023 docstr= PyString_InternFromString("__doc__");
Guido van Rossum019f4241996-08-21 14:54:28 +000024 if (docstr == NULL)
25 return NULL;
26 }
Guido van Rossum7cc56eb1997-09-12 20:04:46 +000027 if (modstr == NULL) {
28 modstr= PyString_InternFromString("__module__");
29 if (modstr == NULL)
30 return NULL;
31 }
32 if (namestr == NULL) {
33 namestr= PyString_InternFromString("__name__");
34 if (namestr == NULL)
35 return NULL;
36 }
Guido van Rossum04d73c41997-10-07 14:54:11 +000037 if (name == NULL || !PyString_Check(name)) {
38 PyErr_SetString(PyExc_SystemError,
39 "PyClass_New: name must be a string");
40 return NULL;
41 }
42 if (dict == NULL || !PyDict_Check(dict)) {
43 PyErr_SetString(PyExc_SystemError,
44 "PyClass_New: dict must be a dictionary");
45 return NULL;
46 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +000047 if (PyDict_GetItem(dict, docstr) == NULL) {
48 if (PyDict_SetItem(dict, docstr, Py_None) < 0)
Guido van Rossume7d444f1995-01-07 12:35:18 +000049 return NULL;
50 }
Guido van Rossum7cc56eb1997-09-12 20:04:46 +000051 if (PyDict_GetItem(dict, modstr) == NULL) {
52 PyObject *globals = PyEval_GetGlobals();
53 if (globals != NULL) {
Guido van Rossum04d73c41997-10-07 14:54:11 +000054 PyObject *modname = PyDict_GetItem(globals, namestr);
55 if (modname != NULL) {
56 if (PyDict_SetItem(dict, modstr, modname) < 0)
Guido van Rossum7cc56eb1997-09-12 20:04:46 +000057 return NULL;
58 }
59 }
60 }
Guido van Rossume2966a61991-12-10 13:53:23 +000061 if (bases == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +000062 bases = PyTuple_New(0);
Guido van Rossume2966a61991-12-10 13:53:23 +000063 if (bases == NULL)
Guido van Rossume5372401993-03-16 12:15:04 +000064 return NULL;
Guido van Rossume2966a61991-12-10 13:53:23 +000065 }
Guido van Rossum04d73c41997-10-07 14:54:11 +000066 else {
67 int i;
68 if (!PyTuple_Check(bases)) {
69 PyErr_SetString(PyExc_SystemError,
70 "PyClass_New: bases must be a tuple");
71 return NULL;
72 }
73 i = PyTuple_Size(bases);
74 while (--i >= 0) {
75 if (!PyClass_Check(PyTuple_GetItem(bases, i))) {
76 PyErr_SetString(PyExc_SystemError,
77 "PyClass_New: base must be a class");
78 return NULL;
79 }
80 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +000081 Py_INCREF(bases);
Guido van Rossum04d73c41997-10-07 14:54:11 +000082 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +000083 op = PyObject_NEW(PyClassObject, &PyClass_Type);
Guido van Rossume2966a61991-12-10 13:53:23 +000084 if (op == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +000085 Py_DECREF(bases);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000086 return NULL;
Guido van Rossume2966a61991-12-10 13:53:23 +000087 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000088 op->cl_bases = bases;
Guido van Rossumc0b618a1997-05-02 03:12:38 +000089 Py_INCREF(dict);
Guido van Rossum81daa321993-05-20 14:24:46 +000090 op->cl_dict = dict;
Guido van Rossumc0b618a1997-05-02 03:12:38 +000091 Py_XINCREF(name);
Guido van Rossum94308391991-10-20 20:11:48 +000092 op->cl_name = name;
Guido van Rossum2878a691996-08-09 20:53:24 +000093 if (getattrstr == NULL) {
Guido van Rossuma412d241997-01-18 07:59:12 +000094 getattrstr = PyString_InternFromString("__getattr__");
95 setattrstr = PyString_InternFromString("__setattr__");
96 delattrstr = PyString_InternFromString("__delattr__");
Guido van Rossum2878a691996-08-09 20:53:24 +000097 }
98 op->cl_getattr = class_lookup(op, getattrstr, &dummy);
99 op->cl_setattr = class_lookup(op, setattrstr, &dummy);
100 op->cl_delattr = class_lookup(op, delattrstr, &dummy);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000101 Py_XINCREF(op->cl_getattr);
102 Py_XINCREF(op->cl_setattr);
103 Py_XINCREF(op->cl_delattr);
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +0000104 PyObject_GC_Init(op);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000105 return (PyObject *) op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000106}
107
108/* Class methods */
109
110static void
Fred Drake79912472000-07-09 04:06:11 +0000111class_dealloc(PyClassObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000112{
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +0000113 PyObject_GC_Fini(op);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000114 Py_DECREF(op->cl_bases);
115 Py_DECREF(op->cl_dict);
116 Py_XDECREF(op->cl_name);
Guido van Rossum152d8171998-08-04 14:59:16 +0000117 Py_XDECREF(op->cl_getattr);
118 Py_XDECREF(op->cl_setattr);
119 Py_XDECREF(op->cl_delattr);
Guido van Rossum4cc6ac72000-07-01 01:00:38 +0000120 op = (PyClassObject *) PyObject_AS_GC(op);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000121 PyObject_DEL(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000122}
123
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000124static PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000125class_lookup(PyClassObject *cp, PyObject *name, PyClassObject **pclass)
Guido van Rossum81daa321993-05-20 14:24:46 +0000126{
127 int i, n;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000128 PyObject *value = PyDict_GetItem(cp->cl_dict, name);
Guido van Rossum81daa321993-05-20 14:24:46 +0000129 if (value != NULL) {
130 *pclass = cp;
131 return value;
132 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000133 n = PyTuple_Size(cp->cl_bases);
Guido van Rossum81daa321993-05-20 14:24:46 +0000134 for (i = 0; i < n; i++) {
Guido van Rossum7cc56eb1997-09-12 20:04:46 +0000135 /* XXX What if one of the bases is not a class? */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000136 PyObject *v = class_lookup(
137 (PyClassObject *)
138 PyTuple_GetItem(cp->cl_bases, i), name, pclass);
Guido van Rossum81daa321993-05-20 14:24:46 +0000139 if (v != NULL)
140 return v;
141 }
142 return NULL;
143}
144
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000145static PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000146class_getattr(register PyClassObject *op, PyObject *name)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000147{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000148 register PyObject *v;
149 register char *sname = PyString_AsString(name);
150 PyClassObject *class;
Guido van Rossum2878a691996-08-09 20:53:24 +0000151 if (sname[0] == '_' && sname[1] == '_') {
152 if (strcmp(sname, "__dict__") == 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000153 if (PyEval_GetRestricted()) {
154 PyErr_SetString(PyExc_RuntimeError,
155 "class.__dict__ not accessible in restricted mode");
Guido van Rossum10393b11995-01-10 10:39:49 +0000156 return NULL;
157 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000158 Py_INCREF(op->cl_dict);
Guido van Rossum10393b11995-01-10 10:39:49 +0000159 return op->cl_dict;
160 }
Guido van Rossum2878a691996-08-09 20:53:24 +0000161 if (strcmp(sname, "__bases__") == 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000162 Py_INCREF(op->cl_bases);
Guido van Rossum10393b11995-01-10 10:39:49 +0000163 return op->cl_bases;
164 }
Guido van Rossum2878a691996-08-09 20:53:24 +0000165 if (strcmp(sname, "__name__") == 0) {
Guido van Rossum10393b11995-01-10 10:39:49 +0000166 if (op->cl_name == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000167 v = Py_None;
Guido van Rossum10393b11995-01-10 10:39:49 +0000168 else
169 v = op->cl_name;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000170 Py_INCREF(v);
Guido van Rossum10393b11995-01-10 10:39:49 +0000171 return v;
172 }
Guido van Rossum94308391991-10-20 20:11:48 +0000173 }
Guido van Rossum81daa321993-05-20 14:24:46 +0000174 v = class_lookup(op, name, &class);
Guido van Rossumb3f72581993-05-21 19:56:10 +0000175 if (v == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000176 PyErr_SetObject(PyExc_AttributeError, name);
Guido van Rossumb3f72581993-05-21 19:56:10 +0000177 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000178 }
Guido van Rossum0add15f1997-05-09 01:07:15 +0000179 Py_INCREF(v);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000180 if (PyFunction_Check(v)) {
181 PyObject *w = PyMethod_New(v, (PyObject *)NULL,
182 (PyObject *)class);
183 Py_DECREF(v);
Guido van Rossumb3f72581993-05-21 19:56:10 +0000184 v = w;
185 }
186 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000187}
188
Guido van Rossuma63eff61998-05-29 21:37:21 +0000189static void
Fred Drake79912472000-07-09 04:06:11 +0000190set_slot(PyObject **slot, PyObject *v)
Guido van Rossuma63eff61998-05-29 21:37:21 +0000191{
192 PyObject *temp = *slot;
193 Py_XINCREF(v);
194 *slot = v;
195 Py_XDECREF(temp);
196}
197
Guido van Rossum7ba30431998-07-08 13:34:48 +0000198static void
Fred Drake79912472000-07-09 04:06:11 +0000199set_attr_slots(PyClassObject *c)
Guido van Rossum7ba30431998-07-08 13:34:48 +0000200{
201 PyClassObject *dummy;
202
203 set_slot(&c->cl_getattr, class_lookup(c, getattrstr, &dummy));
204 set_slot(&c->cl_setattr, class_lookup(c, setattrstr, &dummy));
205 set_slot(&c->cl_delattr, class_lookup(c, delattrstr, &dummy));
206}
207
Guido van Rossuma63eff61998-05-29 21:37:21 +0000208static char *
Fred Drake79912472000-07-09 04:06:11 +0000209set_dict(PyClassObject *c, PyObject *v)
Guido van Rossuma63eff61998-05-29 21:37:21 +0000210{
Guido van Rossuma63eff61998-05-29 21:37:21 +0000211 if (v == NULL || !PyDict_Check(v))
212 return "__dict__ must be a dictionary object";
213 set_slot(&c->cl_dict, v);
Guido van Rossum7ba30431998-07-08 13:34:48 +0000214 set_attr_slots(c);
Guido van Rossuma63eff61998-05-29 21:37:21 +0000215 return "";
216}
217
218static char *
Fred Drake79912472000-07-09 04:06:11 +0000219set_bases(PyClassObject *c, PyObject *v)
Guido van Rossuma63eff61998-05-29 21:37:21 +0000220{
Guido van Rossuma63eff61998-05-29 21:37:21 +0000221 int i, n;
222
223 if (v == NULL || !PyTuple_Check(v))
224 return "__bases__ must be a tuple object";
225 n = PyTuple_Size(v);
226 for (i = 0; i < n; i++) {
227 PyObject *x = PyTuple_GET_ITEM(v, i);
228 if (!PyClass_Check(x))
229 return "__bases__ items must be classes";
230 if (PyClass_IsSubclass(x, (PyObject *)c))
231 return "a __bases__ item causes an inheritance cycle";
232 }
233 set_slot(&c->cl_bases, v);
Guido van Rossum7ba30431998-07-08 13:34:48 +0000234 set_attr_slots(c);
Guido van Rossuma63eff61998-05-29 21:37:21 +0000235 return "";
236}
237
238static char *
Fred Drake79912472000-07-09 04:06:11 +0000239set_name(PyClassObject *c, PyObject *v)
Guido van Rossuma63eff61998-05-29 21:37:21 +0000240{
Guido van Rossuma63eff61998-05-29 21:37:21 +0000241 if (v == NULL || !PyString_Check(v))
242 return "__name__ must be a string object";
Guido van Rossumad89bbc2000-06-28 21:57:18 +0000243 if (strlen(PyString_AS_STRING(v)) != (size_t)PyString_GET_SIZE(v))
Guido van Rossuma63eff61998-05-29 21:37:21 +0000244 return "__name__ must not contain null bytes";
245 set_slot(&c->cl_name, v);
246 return "";
247}
248
Guido van Rossum94308391991-10-20 20:11:48 +0000249static int
Fred Drake79912472000-07-09 04:06:11 +0000250class_setattr(PyClassObject *op, PyObject *name, PyObject *v)
Guido van Rossum94308391991-10-20 20:11:48 +0000251{
Guido van Rossumb2173c31997-08-25 21:23:56 +0000252 char *sname;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000253 if (PyEval_GetRestricted()) {
254 PyErr_SetString(PyExc_RuntimeError,
Guido van Rossumac21f6a1995-08-04 04:05:31 +0000255 "classes are read-only in restricted mode");
256 return -1;
257 }
Guido van Rossumb2173c31997-08-25 21:23:56 +0000258 sname = PyString_AsString(name);
259 if (sname[0] == '_' && sname[1] == '_') {
260 int n = PyString_Size(name);
261 if (sname[n-1] == '_' && sname[n-2] == '_') {
Guido van Rossuma63eff61998-05-29 21:37:21 +0000262 char *err = NULL;
263 if (strcmp(sname, "__dict__") == 0)
264 err = set_dict(op, v);
265 else if (strcmp(sname, "__bases__") == 0)
266 err = set_bases(op, v);
267 else if (strcmp(sname, "__name__") == 0)
268 err = set_name(op, v);
269 else if (strcmp(sname, "__getattr__") == 0)
270 set_slot(&op->cl_getattr, v);
271 else if (strcmp(sname, "__setattr__") == 0)
272 set_slot(&op->cl_setattr, v);
273 else if (strcmp(sname, "__delattr__") == 0)
274 set_slot(&op->cl_delattr, v);
275 /* For the last three, we fall through to update the
276 dictionary as well. */
277 if (err != NULL) {
278 if (*err == '\0')
279 return 0;
280 PyErr_SetString(PyExc_TypeError, err);
Guido van Rossumb2173c31997-08-25 21:23:56 +0000281 return -1;
282 }
283 }
284 }
Guido van Rossum94472a01992-09-04 09:45:18 +0000285 if (v == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000286 int rv = PyDict_DelItem(op->cl_dict, name);
Guido van Rossum94472a01992-09-04 09:45:18 +0000287 if (rv < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000288 PyErr_SetString(PyExc_AttributeError,
Guido van Rossum94472a01992-09-04 09:45:18 +0000289 "delete non-existing class attribute");
290 return rv;
291 }
Guido van Rossum94308391991-10-20 20:11:48 +0000292 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000293 return PyDict_SetItem(op->cl_dict, name, v);
Guido van Rossum94308391991-10-20 20:11:48 +0000294}
295
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000296static PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000297class_repr(PyClassObject *op)
Guido van Rossum25831651993-05-19 14:50:45 +0000298{
Guido van Rossum4a2a6211997-10-20 23:26:11 +0000299 PyObject *mod = PyDict_GetItemString(op->cl_dict, "__module__");
Guido van Rossum25831651993-05-19 14:50:45 +0000300 char buf[140];
301 char *name;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000302 if (op->cl_name == NULL || !PyString_Check(op->cl_name))
Guido van Rossum25831651993-05-19 14:50:45 +0000303 name = "?";
304 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000305 name = PyString_AsString(op->cl_name);
Guido van Rossum4a2a6211997-10-20 23:26:11 +0000306 if (mod == NULL || !PyString_Check(mod))
Fred Drakea44d3532000-06-30 15:01:00 +0000307 sprintf(buf, "<class ?.%.100s at %p>", name, op);
Guido van Rossum4a2a6211997-10-20 23:26:11 +0000308 else
Fred Drakea44d3532000-06-30 15:01:00 +0000309 sprintf(buf, "<class %.50s.%.50s at %p>",
Guido van Rossum4a2a6211997-10-20 23:26:11 +0000310 PyString_AsString(mod),
Fred Drakea44d3532000-06-30 15:01:00 +0000311 name, op);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000312 return PyString_FromString(buf);
Guido van Rossum25831651993-05-19 14:50:45 +0000313}
314
Guido van Rossum4a2a6211997-10-20 23:26:11 +0000315static PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000316class_str(PyClassObject *op)
Guido van Rossum4a2a6211997-10-20 23:26:11 +0000317{
318 PyObject *mod = PyDict_GetItemString(op->cl_dict, "__module__");
319 PyObject *name = op->cl_name;
320 PyObject *res;
321 int m, n;
322
323 if (name == NULL || !PyString_Check(name))
324 return class_repr(op);
325 if (mod == NULL || !PyString_Check(mod)) {
326 Py_INCREF(name);
327 return name;
328 }
329 m = PyString_Size(mod);
330 n = PyString_Size(name);
331 res = PyString_FromStringAndSize((char *)NULL, m+1+n);
332 if (res != NULL) {
333 char *s = PyString_AsString(res);
334 memcpy(s, PyString_AsString(mod), m);
335 s += m;
336 *s++ = '.';
337 memcpy(s, PyString_AsString(name), n);
338 }
339 return res;
340}
341
Jeremy Hylton8caad492000-06-23 14:18:11 +0000342static int
343class_traverse(PyClassObject *o, visitproc visit, void *arg)
344{
345 int err;
346 if (o->cl_bases) {
347 err = visit(o->cl_bases, arg);
348 if (err)
349 return err;
350 }
351 if (o->cl_dict) {
352 err = visit(o->cl_dict, arg);
353 if (err)
354 return err;
355 }
356 if (o->cl_name) {
357 err = visit(o->cl_name, arg);
358 if (err)
359 return err;
360 }
361 if (o->cl_getattr) {
362 err = visit(o->cl_getattr, arg);
363 if (err)
364 return err;
365 }
366 if (o->cl_setattr) {
367 err = visit(o->cl_setattr, arg);
368 if (err)
369 return err;
370 }
371 if (o->cl_delattr) {
372 err = visit(o->cl_delattr, arg);
373 if (err)
374 return err;
375 }
376 return 0;
377}
378
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000379PyTypeObject PyClass_Type = {
380 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000381 0,
382 "class",
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +0000383 sizeof(PyClassObject) + PyGC_HEAD_SIZE,
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000384 0,
Guido van Rossumb6775db1994-08-01 11:34:53 +0000385 (destructor)class_dealloc, /*tp_dealloc*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000386 0, /*tp_print*/
Guido van Rossum2878a691996-08-09 20:53:24 +0000387 0, /*tp_getattr*/
388 0, /*tp_setattr*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000389 0, /*tp_compare*/
Guido van Rossumb6775db1994-08-01 11:34:53 +0000390 (reprfunc)class_repr, /*tp_repr*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000391 0, /*tp_as_number*/
392 0, /*tp_as_sequence*/
393 0, /*tp_as_mapping*/
Guido van Rossum2878a691996-08-09 20:53:24 +0000394 0, /*tp_hash*/
395 0, /*tp_call*/
Guido van Rossum4a2a6211997-10-20 23:26:11 +0000396 (reprfunc)class_str, /*tp_str*/
Guido van Rossum2878a691996-08-09 20:53:24 +0000397 (getattrofunc)class_getattr, /*tp_getattro*/
398 (setattrofunc)class_setattr, /*tp_setattro*/
Jeremy Hylton8caad492000-06-23 14:18:11 +0000399 0, /* tp_as_buffer */
Jeremy Hyltond08b4c42000-06-23 19:37:02 +0000400 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_GC, /*tp_flags*/
Jeremy Hylton8caad492000-06-23 14:18:11 +0000401 0, /* tp_doc */
402 (traverseproc)class_traverse, /* tp_traverse */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000403};
404
Guido van Rossum81daa321993-05-20 14:24:46 +0000405int
Fred Drake79912472000-07-09 04:06:11 +0000406PyClass_IsSubclass(PyObject *class, PyObject *base)
Guido van Rossum81daa321993-05-20 14:24:46 +0000407{
408 int i, n;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000409 PyClassObject *cp;
Guido van Rossum81daa321993-05-20 14:24:46 +0000410 if (class == base)
411 return 1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000412 if (class == NULL || !PyClass_Check(class))
Guido van Rossumeb6b33a1993-05-25 09:38:27 +0000413 return 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000414 cp = (PyClassObject *)class;
415 n = PyTuple_Size(cp->cl_bases);
Guido van Rossum81daa321993-05-20 14:24:46 +0000416 for (i = 0; i < n; i++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000417 if (PyClass_IsSubclass(PyTuple_GetItem(cp->cl_bases, i), base))
Guido van Rossum81daa321993-05-20 14:24:46 +0000418 return 1;
419 }
420 return 0;
421}
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000422
Guido van Rossum81daa321993-05-20 14:24:46 +0000423
424/* Instance objects */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000425
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000426PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000427PyInstance_New(PyObject *class, PyObject *arg, PyObject *kw)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000428{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000429 register PyInstanceObject *inst;
430 PyObject *init;
431 static PyObject *initstr;
432 if (!PyClass_Check(class)) {
433 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000434 return NULL;
435 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000436 inst = PyObject_NEW(PyInstanceObject, &PyInstance_Type);
Guido van Rossume8122f11991-05-05 20:03:07 +0000437 if (inst == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000438 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000439 inst->in_dict = PyDict_New();
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +0000440 PyObject_GC_Init(inst);
Guido van Rossum0add15f1997-05-09 01:07:15 +0000441 if (inst->in_dict == NULL) {
Guido van Rossum4cc6ac72000-07-01 01:00:38 +0000442 inst = (PyInstanceObject *) PyObject_AS_GC(inst);
Guido van Rossumd7823f22000-06-28 23:46:07 +0000443 PyObject_DEL(inst);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000444 return NULL;
445 }
Guido van Rossumd7823f22000-06-28 23:46:07 +0000446 Py_INCREF(class);
447 inst->in_class = (PyClassObject *)class;
Guido van Rossum2878a691996-08-09 20:53:24 +0000448 if (initstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +0000449 initstr = PyString_InternFromString("__init__");
Jeremy Hylton9e392e22000-04-26 20:39:20 +0000450 init = instance_getattr2(inst, initstr);
Guido van Rossum25831651993-05-19 14:50:45 +0000451 if (init == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000452 if ((arg != NULL && (!PyTuple_Check(arg) ||
453 PyTuple_Size(arg) != 0))
454 || (kw != NULL && (!PyDict_Check(kw) ||
455 PyDict_Size(kw) != 0))) {
456 PyErr_SetString(PyExc_TypeError,
Guido van Rossuma83f2701995-07-26 18:07:32 +0000457 "this constructor takes no arguments");
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000458 Py_DECREF(inst);
Guido van Rossum25831651993-05-19 14:50:45 +0000459 inst = NULL;
460 }
461 }
462 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000463 PyObject *res = PyEval_CallObjectWithKeywords(init, arg, kw);
464 Py_DECREF(init);
Guido van Rossum25831651993-05-19 14:50:45 +0000465 if (res == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000466 Py_DECREF(inst);
Guido van Rossum25831651993-05-19 14:50:45 +0000467 inst = NULL;
468 }
469 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000470 if (res != Py_None) {
471 PyErr_SetString(PyExc_TypeError,
Guido van Rossum25831651993-05-19 14:50:45 +0000472 "__init__() should return None");
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000473 Py_DECREF(inst);
Guido van Rossum25831651993-05-19 14:50:45 +0000474 inst = NULL;
475 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000476 Py_DECREF(res);
Guido van Rossum25831651993-05-19 14:50:45 +0000477 }
478 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000479 return (PyObject *)inst;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000480}
481
Guido van Rossum21ed88c1991-04-04 10:42:10 +0000482/* Instance methods */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000483
484static void
Fred Drake79912472000-07-09 04:06:11 +0000485instance_dealloc(register PyInstanceObject *inst)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000486{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000487 PyObject *error_type, *error_value, *error_traceback;
488 PyObject *del;
489 static PyObject *delstr;
Skip Montanaro4ca150b2000-07-08 12:04:57 +0000490#ifdef Py_TRACE_REFS
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +0000491 extern long _Py_RefTotal;
Skip Montanaro4ca150b2000-07-08 12:04:57 +0000492#endif
Guido van Rossum25831651993-05-19 14:50:45 +0000493 /* Call the __del__ method if it exists. First temporarily
494 revive the object and save the current exception, if any. */
Guido van Rossum441e4ab1996-05-23 22:46:51 +0000495#ifdef Py_TRACE_REFS
496 /* much too complicated if Py_TRACE_REFS defined */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000497 inst->ob_type = &PyInstance_Type;
Guido van Rossumbffd6832000-01-20 22:32:56 +0000498 _Py_NewReference((PyObject *)inst);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000499 _Py_RefTotal--; /* compensate for increment in NEWREF */
Sjoerd Mullender740f3571995-08-28 09:00:43 +0000500#ifdef COUNT_ALLOCS
501 inst->ob_type->tp_alloc--; /* ditto */
502#endif
Guido van Rossum441e4ab1996-05-23 22:46:51 +0000503#else /* !Py_TRACE_REFS */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000504 Py_INCREF(inst);
Guido van Rossum441e4ab1996-05-23 22:46:51 +0000505#endif /* !Py_TRACE_REFS */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000506 PyErr_Fetch(&error_type, &error_value, &error_traceback);
Guido van Rossum2878a691996-08-09 20:53:24 +0000507 if (delstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +0000508 delstr = PyString_InternFromString("__del__");
Jeremy Hylton9e392e22000-04-26 20:39:20 +0000509 if ((del = instance_getattr2(inst, delstr)) != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000510 PyObject *res = PyEval_CallObject(del, (PyObject *)NULL);
Guido van Rossum0dfcf751996-08-12 22:00:53 +0000511 if (res == NULL) {
Jeremy Hyltonb709df32000-09-01 02:47:25 +0000512 PyErr_WriteUnraisable(del);
Guido van Rossum0dfcf751996-08-12 22:00:53 +0000513 }
514 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000515 Py_DECREF(res);
516 Py_DECREF(del);
Guido van Rossum25831651993-05-19 14:50:45 +0000517 }
518 /* Restore the saved exception and undo the temporary revival */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000519 PyErr_Restore(error_type, error_value, error_traceback);
Guido van Rossum25831651993-05-19 14:50:45 +0000520 /* Can't use DECREF here, it would cause a recursive call */
Sjoerd Mullender740f3571995-08-28 09:00:43 +0000521 if (--inst->ob_refcnt > 0) {
522#ifdef COUNT_ALLOCS
523 inst->ob_type->tp_free--;
524#endif
Guido van Rossum25831651993-05-19 14:50:45 +0000525 return; /* __del__ added a reference; don't delete now */
Sjoerd Mullender740f3571995-08-28 09:00:43 +0000526 }
Guido van Rossum441e4ab1996-05-23 22:46:51 +0000527#ifdef Py_TRACE_REFS
Sjoerd Mullender740f3571995-08-28 09:00:43 +0000528#ifdef COUNT_ALLOCS
529 inst->ob_type->tp_free--; /* compensate for increment in UNREF */
530#endif
Guido van Rossumbffd6832000-01-20 22:32:56 +0000531 _Py_ForgetReference((PyObject *)inst);
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +0000532#ifndef WITH_CYCLE_GC
Sjoerd Mullender740f3571995-08-28 09:00:43 +0000533 inst->ob_type = NULL;
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +0000534#endif
Guido van Rossum441e4ab1996-05-23 22:46:51 +0000535#endif /* Py_TRACE_REFS */
Neil Schemenauerce209672000-09-15 18:57:21 +0000536 PyObject_GC_Fini(inst);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000537 Py_DECREF(inst->in_class);
538 Py_XDECREF(inst->in_dict);
Guido van Rossum4cc6ac72000-07-01 01:00:38 +0000539 inst = (PyInstanceObject *) PyObject_AS_GC(inst);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000540 PyObject_DEL(inst);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000541}
542
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000543static PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000544instance_getattr1(register PyInstanceObject *inst, PyObject *name)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000545{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000546 register PyObject *v;
547 register char *sname = PyString_AsString(name);
Guido van Rossum2878a691996-08-09 20:53:24 +0000548 if (sname[0] == '_' && sname[1] == '_') {
549 if (strcmp(sname, "__dict__") == 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000550 if (PyEval_GetRestricted()) {
551 PyErr_SetString(PyExc_RuntimeError,
552 "instance.__dict__ not accessible in restricted mode");
Guido van Rossum10393b11995-01-10 10:39:49 +0000553 return NULL;
554 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000555 Py_INCREF(inst->in_dict);
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000556 return inst->in_dict;
557 }
Guido van Rossum2878a691996-08-09 20:53:24 +0000558 if (strcmp(sname, "__class__") == 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000559 Py_INCREF(inst->in_class);
560 return (PyObject *)inst->in_class;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000561 }
Guido van Rossum94308391991-10-20 20:11:48 +0000562 }
Jeremy Hylton9e392e22000-04-26 20:39:20 +0000563 v = instance_getattr2(inst, name);
564 if (v == NULL) {
565 PyErr_Format(PyExc_AttributeError,"'%.50s' instance has no attribute '%.400s'",
566 PyString_AS_STRING(inst->in_class->cl_name), sname);
567 }
568 return v;
569}
570
571static PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000572instance_getattr2(register PyInstanceObject *inst, PyObject *name)
Jeremy Hylton9e392e22000-04-26 20:39:20 +0000573{
574 register PyObject *v;
575 PyClassObject *class;
Guido van Rossumeb6b33a1993-05-25 09:38:27 +0000576 class = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000577 v = PyDict_GetItem(inst->in_dict, name);
Guido van Rossumb3f72581993-05-21 19:56:10 +0000578 if (v == NULL) {
579 v = class_lookup(inst->in_class, name, &class);
Jeremy Hylton9e392e22000-04-26 20:39:20 +0000580 if (v == NULL)
581 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000582 }
Guido van Rossum0add15f1997-05-09 01:07:15 +0000583 Py_INCREF(v);
Guido van Rossum21d335e1993-10-15 13:01:11 +0000584 if (class != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000585 if (PyFunction_Check(v)) {
586 PyObject *w = PyMethod_New(v, (PyObject *)inst,
587 (PyObject *)class);
588 Py_DECREF(v);
Guido van Rossum21d335e1993-10-15 13:01:11 +0000589 v = w;
590 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000591 else if (PyMethod_Check(v)) {
592 PyObject *im_class = PyMethod_Class(v);
Guido van Rossum21d335e1993-10-15 13:01:11 +0000593 /* Only if classes are compatible */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000594 if (PyClass_IsSubclass((PyObject *)class, im_class)) {
595 PyObject *im_func = PyMethod_Function(v);
596 PyObject *w = PyMethod_New(im_func,
597 (PyObject *)inst, im_class);
598 Py_DECREF(v);
Guido van Rossum21d335e1993-10-15 13:01:11 +0000599 v = w;
600 }
601 }
Guido van Rossumb3f72581993-05-21 19:56:10 +0000602 }
603 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000604}
605
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000606static PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000607instance_getattr(register PyInstanceObject *inst, PyObject *name)
Guido van Rossume7737541994-09-05 07:31:41 +0000608{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000609 register PyObject *func, *res;
Guido van Rossum52ca98a1994-09-05 07:32:29 +0000610 res = instance_getattr1(inst, name);
611 if (res == NULL && (func = inst->in_class->cl_getattr) != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000612 PyObject *args;
613 PyErr_Clear();
614 args = Py_BuildValue("(OO)", inst, name);
Guido van Rossum52ca98a1994-09-05 07:32:29 +0000615 if (args == NULL)
Guido van Rossume7737541994-09-05 07:31:41 +0000616 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000617 res = PyEval_CallObject(func, args);
618 Py_DECREF(args);
Guido van Rossume7737541994-09-05 07:31:41 +0000619 }
620 return res;
621}
622
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000623static int
Fred Drake79912472000-07-09 04:06:11 +0000624instance_setattr1(PyInstanceObject *inst, PyObject *name, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000625{
Guido van Rossum94472a01992-09-04 09:45:18 +0000626 if (v == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000627 int rv = PyDict_DelItem(inst->in_dict, name);
Guido van Rossum94472a01992-09-04 09:45:18 +0000628 if (rv < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000629 PyErr_SetString(PyExc_AttributeError,
Guido van Rossum94472a01992-09-04 09:45:18 +0000630 "delete non-existing instance attribute");
631 return rv;
632 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000633 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000634 return PyDict_SetItem(inst->in_dict, name, v);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000635}
636
Guido van Rossume7737541994-09-05 07:31:41 +0000637static int
Fred Drake79912472000-07-09 04:06:11 +0000638instance_setattr(PyInstanceObject *inst, PyObject *name, PyObject *v)
Guido van Rossume7737541994-09-05 07:31:41 +0000639{
Guido van Rossumb2173c31997-08-25 21:23:56 +0000640 PyObject *func, *args, *res, *tmp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000641 char *sname = PyString_AsString(name);
Guido van Rossumb2173c31997-08-25 21:23:56 +0000642 if (sname[0] == '_' && sname[1] == '_') {
643 int n = PyString_Size(name);
Guido van Rossum2878a691996-08-09 20:53:24 +0000644 if (sname[n-1] == '_' && sname[n-2] == '_') {
Guido van Rossumb2173c31997-08-25 21:23:56 +0000645 if (strcmp(sname, "__dict__") == 0) {
646 if (PyEval_GetRestricted()) {
647 PyErr_SetString(PyExc_RuntimeError,
648 "__dict__ not accessible in restricted mode");
649 return -1;
650 }
651 if (v == NULL || !PyDict_Check(v)) {
652 PyErr_SetString(PyExc_TypeError,
653 "__dict__ must be set to a dictionary");
654 return -1;
655 }
656 tmp = inst->in_dict;
657 Py_INCREF(v);
658 inst->in_dict = v;
659 Py_DECREF(tmp);
660 return 0;
661 }
662 if (strcmp(sname, "__class__") == 0) {
663 if (PyEval_GetRestricted()) {
664 PyErr_SetString(PyExc_RuntimeError,
665 "__class__ not accessible in restricted mode");
666 return -1;
667 }
668 if (v == NULL || !PyClass_Check(v)) {
669 PyErr_SetString(PyExc_TypeError,
670 "__class__ must be set to a class");
671 return -1;
672 }
673 tmp = (PyObject *)(inst->in_class);
674 Py_INCREF(v);
675 inst->in_class = (PyClassObject *)v;
676 Py_DECREF(tmp);
677 return 0;
678 }
Guido van Rossume7737541994-09-05 07:31:41 +0000679 }
Guido van Rossume7737541994-09-05 07:31:41 +0000680 }
Guido van Rossum52ca98a1994-09-05 07:32:29 +0000681 if (v == NULL)
682 func = inst->in_class->cl_delattr;
683 else
684 func = inst->in_class->cl_setattr;
685 if (func == NULL)
686 return instance_setattr1(inst, name, v);
687 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000688 args = Py_BuildValue("(OO)", inst, name);
Guido van Rossum52ca98a1994-09-05 07:32:29 +0000689 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000690 args = Py_BuildValue("(OOO)", inst, name, v);
Guido van Rossum52ca98a1994-09-05 07:32:29 +0000691 if (args == NULL)
692 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000693 res = PyEval_CallObject(func, args);
694 Py_DECREF(args);
Guido van Rossum52ca98a1994-09-05 07:32:29 +0000695 if (res == NULL)
696 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000697 Py_DECREF(res);
Guido van Rossume7737541994-09-05 07:31:41 +0000698 return 0;
699}
700
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000701static PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000702instance_repr(PyInstanceObject *inst)
Guido van Rossum04691fc1992-08-12 15:35:34 +0000703{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000704 PyObject *func;
705 PyObject *res;
706 static PyObject *reprstr;
Guido van Rossum04691fc1992-08-12 15:35:34 +0000707
Guido van Rossum2878a691996-08-09 20:53:24 +0000708 if (reprstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +0000709 reprstr = PyString_InternFromString("__repr__");
Guido van Rossum2878a691996-08-09 20:53:24 +0000710 func = instance_getattr(inst, reprstr);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000711 if (func == NULL) {
Guido van Rossum25831651993-05-19 14:50:45 +0000712 char buf[140];
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000713 PyObject *classname = inst->in_class->cl_name;
Guido van Rossumb7f1afe1997-12-03 00:06:02 +0000714 PyObject *mod = PyDict_GetItemString(
715 inst->in_class->cl_dict, "__module__");
Guido van Rossum25831651993-05-19 14:50:45 +0000716 char *cname;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000717 if (classname != NULL && PyString_Check(classname))
718 cname = PyString_AsString(classname);
Guido van Rossum25831651993-05-19 14:50:45 +0000719 else
720 cname = "?";
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000721 PyErr_Clear();
Guido van Rossumb7f1afe1997-12-03 00:06:02 +0000722 if (mod == NULL || !PyString_Check(mod))
Fred Drakea44d3532000-06-30 15:01:00 +0000723 sprintf(buf, "<?.%.100s instance at %p>",
724 cname, inst);
Guido van Rossumb7f1afe1997-12-03 00:06:02 +0000725 else
Fred Drakea44d3532000-06-30 15:01:00 +0000726 sprintf(buf, "<%.50s.%.50s instance at %p>",
Guido van Rossumb7f1afe1997-12-03 00:06:02 +0000727 PyString_AsString(mod),
Fred Drakea44d3532000-06-30 15:01:00 +0000728 cname, inst);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000729 return PyString_FromString(buf);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000730 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000731 res = PyEval_CallObject(func, (PyObject *)NULL);
732 Py_DECREF(func);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000733 return res;
734}
735
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000736static PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000737instance_compare1(PyObject *inst, PyObject *other)
Guido van Rossume7d444f1995-01-07 12:35:18 +0000738{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000739 return PyInstance_DoBinOp(inst, other, "__cmp__", "__rcmp__",
Guido van Rossume7d444f1995-01-07 12:35:18 +0000740 instance_compare1);
741}
742
Guido van Rossum9bfef441993-03-29 10:43:31 +0000743static int
Fred Drake79912472000-07-09 04:06:11 +0000744instance_compare(PyObject *inst, PyObject *other)
Guido van Rossum04691fc1992-08-12 15:35:34 +0000745{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000746 PyObject *result;
Guido van Rossume7d444f1995-01-07 12:35:18 +0000747 long outcome;
748 result = instance_compare1(inst, other);
Guido van Rossumc8b6df91997-05-23 00:06:51 +0000749 if (result == NULL)
750 return -1;
751 if (!PyInt_Check(result)) {
752 Py_DECREF(result);
753 PyErr_SetString(PyExc_TypeError,
754 "comparison did not return an int");
755 return -1;
Sjoerd Mullenderb9a6d121994-10-19 15:11:52 +0000756 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000757 outcome = PyInt_AsLong(result);
758 Py_DECREF(result);
Guido van Rossum03093a21994-09-28 15:51:32 +0000759 if (outcome < 0)
760 return -1;
761 else if (outcome > 0)
762 return 1;
763 return 0;
Guido van Rossum04691fc1992-08-12 15:35:34 +0000764}
765
Guido van Rossum9bfef441993-03-29 10:43:31 +0000766static long
Fred Drake79912472000-07-09 04:06:11 +0000767instance_hash(PyInstanceObject *inst)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000768{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000769 PyObject *func;
770 PyObject *res;
Guido van Rossum8a0c3451993-04-08 12:56:19 +0000771 long outcome;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000772 static PyObject *hashstr, *cmpstr;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000773
Guido van Rossum2878a691996-08-09 20:53:24 +0000774 if (hashstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +0000775 hashstr = PyString_InternFromString("__hash__");
Guido van Rossum2878a691996-08-09 20:53:24 +0000776 func = instance_getattr(inst, hashstr);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000777 if (func == NULL) {
778 /* If there is no __cmp__ method, we hash on the address.
779 If a __cmp__ method exists, there must be a __hash__. */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000780 PyErr_Clear();
Guido van Rossum2878a691996-08-09 20:53:24 +0000781 if (cmpstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +0000782 cmpstr = PyString_InternFromString("__cmp__");
Guido van Rossum2878a691996-08-09 20:53:24 +0000783 func = instance_getattr(inst, cmpstr);
Guido van Rossum8a0c3451993-04-08 12:56:19 +0000784 if (func == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000785 PyErr_Clear();
Fred Drake13634cf2000-06-29 19:17:04 +0000786 return _Py_HashPointer(inst);
Guido van Rossum8a0c3451993-04-08 12:56:19 +0000787 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000788 PyErr_SetString(PyExc_TypeError, "unhashable instance");
Guido van Rossum9bfef441993-03-29 10:43:31 +0000789 return -1;
790 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000791 res = PyEval_CallObject(func, (PyObject *)NULL);
792 Py_DECREF(func);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000793 if (res == NULL)
794 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000795 if (PyInt_Check(res)) {
796 outcome = PyInt_AsLong(res);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000797 if (outcome == -1)
798 outcome = -2;
799 }
800 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000801 PyErr_SetString(PyExc_TypeError,
802 "__hash__() should return an int");
Guido van Rossum9bfef441993-03-29 10:43:31 +0000803 outcome = -1;
804 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000805 Py_DECREF(res);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000806 return outcome;
807}
808
Jeremy Hylton8caad492000-06-23 14:18:11 +0000809static int
810instance_traverse(PyInstanceObject *o, visitproc visit, void *arg)
811{
812 int err;
813 if (o->in_class) {
814 err = visit((PyObject *)(o->in_class), arg);
815 if (err)
816 return err;
817 }
818 if (o->in_dict) {
819 err = visit(o->in_dict, arg);
820 if (err)
821 return err;
822 }
Jeremy Hyltond22162b2000-06-23 17:14:56 +0000823 return 0;
Jeremy Hylton8caad492000-06-23 14:18:11 +0000824}
825
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000826static PyObject *getitemstr, *setitemstr, *delitemstr, *lenstr;
Guido van Rossum2878a691996-08-09 20:53:24 +0000827
Guido van Rossum9bfef441993-03-29 10:43:31 +0000828static int
Fred Drake79912472000-07-09 04:06:11 +0000829instance_length(PyInstanceObject *inst)
Guido van Rossum04691fc1992-08-12 15:35:34 +0000830{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000831 PyObject *func;
832 PyObject *res;
Guido van Rossum04691fc1992-08-12 15:35:34 +0000833 int outcome;
834
Guido van Rossum2878a691996-08-09 20:53:24 +0000835 if (lenstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +0000836 lenstr = PyString_InternFromString("__len__");
Guido van Rossum2878a691996-08-09 20:53:24 +0000837 func = instance_getattr(inst, lenstr);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000838 if (func == NULL)
839 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000840 res = PyEval_CallObject(func, (PyObject *)NULL);
841 Py_DECREF(func);
Guido van Rossumd014ea61992-11-26 10:30:26 +0000842 if (res == NULL)
843 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000844 if (PyInt_Check(res)) {
845 outcome = PyInt_AsLong(res);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000846 if (outcome < 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000847 PyErr_SetString(PyExc_ValueError,
848 "__len__() should return >= 0");
Guido van Rossum04691fc1992-08-12 15:35:34 +0000849 }
850 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000851 PyErr_SetString(PyExc_TypeError,
852 "__len__() should return an int");
Guido van Rossum04691fc1992-08-12 15:35:34 +0000853 outcome = -1;
854 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000855 Py_DECREF(res);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000856 return outcome;
857}
858
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000859static PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000860instance_subscript(PyInstanceObject *inst, PyObject *key)
Guido van Rossum04691fc1992-08-12 15:35:34 +0000861{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000862 PyObject *func;
863 PyObject *arg;
864 PyObject *res;
Guido van Rossum04691fc1992-08-12 15:35:34 +0000865
Guido van Rossum2878a691996-08-09 20:53:24 +0000866 if (getitemstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +0000867 getitemstr = PyString_InternFromString("__getitem__");
Guido van Rossum2878a691996-08-09 20:53:24 +0000868 func = instance_getattr(inst, getitemstr);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000869 if (func == NULL)
870 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000871 arg = Py_BuildValue("(O)", key);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000872 if (arg == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000873 Py_DECREF(func);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000874 return NULL;
875 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000876 res = PyEval_CallObject(func, arg);
877 Py_DECREF(func);
878 Py_DECREF(arg);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000879 return res;
880}
881
Guido van Rossum9bfef441993-03-29 10:43:31 +0000882static int
Fred Drake79912472000-07-09 04:06:11 +0000883instance_ass_subscript(PyInstanceObject *inst, PyObject *key, PyObject *value)
Guido van Rossum04691fc1992-08-12 15:35:34 +0000884{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000885 PyObject *func;
886 PyObject *arg;
887 PyObject *res;
Guido van Rossum04691fc1992-08-12 15:35:34 +0000888
Guido van Rossum2878a691996-08-09 20:53:24 +0000889 if (value == NULL) {
890 if (delitemstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +0000891 delitemstr = PyString_InternFromString("__delitem__");
Guido van Rossum2878a691996-08-09 20:53:24 +0000892 func = instance_getattr(inst, delitemstr);
893 }
894 else {
895 if (setitemstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +0000896 setitemstr = PyString_InternFromString("__setitem__");
Guido van Rossum2878a691996-08-09 20:53:24 +0000897 func = instance_getattr(inst, setitemstr);
898 }
Guido van Rossum04691fc1992-08-12 15:35:34 +0000899 if (func == NULL)
900 return -1;
901 if (value == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000902 arg = Py_BuildValue("(O)", key);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000903 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000904 arg = Py_BuildValue("(OO)", key, value);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000905 if (arg == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000906 Py_DECREF(func);
Guido van Rossum6d946f91992-08-14 13:49:30 +0000907 return -1;
Guido van Rossum04691fc1992-08-12 15:35:34 +0000908 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000909 res = PyEval_CallObject(func, arg);
910 Py_DECREF(func);
911 Py_DECREF(arg);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000912 if (res == NULL)
913 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000914 Py_DECREF(res);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000915 return 0;
916}
917
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000918static PyMappingMethods instance_as_mapping = {
Guido van Rossumb6775db1994-08-01 11:34:53 +0000919 (inquiry)instance_length, /*mp_length*/
920 (binaryfunc)instance_subscript, /*mp_subscript*/
921 (objobjargproc)instance_ass_subscript, /*mp_ass_subscript*/
Guido van Rossum04691fc1992-08-12 15:35:34 +0000922};
923
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000924static PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000925instance_item(PyInstanceObject *inst, int i)
Guido van Rossum04691fc1992-08-12 15:35:34 +0000926{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000927 PyObject *func, *arg, *res;
Guido van Rossum04691fc1992-08-12 15:35:34 +0000928
Guido van Rossum2878a691996-08-09 20:53:24 +0000929 if (getitemstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +0000930 getitemstr = PyString_InternFromString("__getitem__");
Guido van Rossum2878a691996-08-09 20:53:24 +0000931 func = instance_getattr(inst, getitemstr);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000932 if (func == NULL)
933 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000934 arg = Py_BuildValue("(i)", i);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000935 if (arg == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000936 Py_DECREF(func);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000937 return NULL;
938 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000939 res = PyEval_CallObject(func, arg);
940 Py_DECREF(func);
941 Py_DECREF(arg);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000942 return res;
943}
944
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000945static PyObject *
Thomas Wouters1d75a792000-08-17 22:37:32 +0000946sliceobj_from_intint(int i, int j)
947{
948 PyObject *start, *end, *res;
949
950 start = PyInt_FromLong((long)i);
951 if (!start)
952 return NULL;
953
954 end = PyInt_FromLong((long)j);
955 if (!end) {
956 Py_DECREF(start);
957 return NULL;
958 }
959 res = PySlice_New(start, end, NULL);
960 Py_DECREF(start);
961 Py_DECREF(end);
962 return res;
963}
964
965
966static PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000967instance_slice(PyInstanceObject *inst, int i, int j)
Guido van Rossum04691fc1992-08-12 15:35:34 +0000968{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000969 PyObject *func, *arg, *res;
970 static PyObject *getslicestr;
Guido van Rossum04691fc1992-08-12 15:35:34 +0000971
Guido van Rossum2878a691996-08-09 20:53:24 +0000972 if (getslicestr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +0000973 getslicestr = PyString_InternFromString("__getslice__");
Guido van Rossum2878a691996-08-09 20:53:24 +0000974 func = instance_getattr(inst, getslicestr);
Thomas Wouters1d75a792000-08-17 22:37:32 +0000975
976 if (func == NULL) {
977 PyErr_Clear();
978
979 if (getitemstr == NULL)
980 getitemstr = PyString_InternFromString("__getitem__");
981 func = instance_getattr(inst, getitemstr);
982 if (func == NULL)
983 return NULL;
984 arg = Py_BuildValue("(N)", sliceobj_from_intint(i, j));
985 } else
986 arg = Py_BuildValue("(ii)", i, j);
987
Guido van Rossum04691fc1992-08-12 15:35:34 +0000988 if (arg == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000989 Py_DECREF(func);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000990 return NULL;
991 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000992 res = PyEval_CallObject(func, arg);
993 Py_DECREF(func);
994 Py_DECREF(arg);
Guido van Rossum04691fc1992-08-12 15:35:34 +0000995 return res;
996}
997
998static int
Fred Drake79912472000-07-09 04:06:11 +0000999instance_ass_item(PyInstanceObject *inst, int i, PyObject *item)
Guido van Rossum04691fc1992-08-12 15:35:34 +00001000{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001001 PyObject *func, *arg, *res;
Guido van Rossum04691fc1992-08-12 15:35:34 +00001002
Guido van Rossum2878a691996-08-09 20:53:24 +00001003 if (item == NULL) {
1004 if (delitemstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +00001005 delitemstr = PyString_InternFromString("__delitem__");
Guido van Rossum2878a691996-08-09 20:53:24 +00001006 func = instance_getattr(inst, delitemstr);
1007 }
1008 else {
1009 if (setitemstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +00001010 setitemstr = PyString_InternFromString("__setitem__");
Guido van Rossum2878a691996-08-09 20:53:24 +00001011 func = instance_getattr(inst, setitemstr);
1012 }
Guido van Rossum04691fc1992-08-12 15:35:34 +00001013 if (func == NULL)
Guido van Rossum6d946f91992-08-14 13:49:30 +00001014 return -1;
Guido van Rossum04691fc1992-08-12 15:35:34 +00001015 if (item == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001016 arg = Py_BuildValue("i", i);
Guido van Rossum04691fc1992-08-12 15:35:34 +00001017 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001018 arg = Py_BuildValue("(iO)", i, item);
Guido van Rossum04691fc1992-08-12 15:35:34 +00001019 if (arg == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001020 Py_DECREF(func);
Guido van Rossum6d946f91992-08-14 13:49:30 +00001021 return -1;
Guido van Rossum04691fc1992-08-12 15:35:34 +00001022 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001023 res = PyEval_CallObject(func, arg);
1024 Py_DECREF(func);
1025 Py_DECREF(arg);
Guido van Rossum04691fc1992-08-12 15:35:34 +00001026 if (res == NULL)
1027 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001028 Py_DECREF(res);
Guido van Rossum04691fc1992-08-12 15:35:34 +00001029 return 0;
1030}
1031
1032static int
Fred Drake79912472000-07-09 04:06:11 +00001033instance_ass_slice(PyInstanceObject *inst, int i, int j, PyObject *value)
Guido van Rossum04691fc1992-08-12 15:35:34 +00001034{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001035 PyObject *func, *arg, *res;
1036 static PyObject *setslicestr, *delslicestr;
Guido van Rossum04691fc1992-08-12 15:35:34 +00001037
Guido van Rossum2878a691996-08-09 20:53:24 +00001038 if (value == NULL) {
1039 if (delslicestr == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001040 delslicestr =
1041 PyString_InternFromString("__delslice__");
Guido van Rossum2878a691996-08-09 20:53:24 +00001042 func = instance_getattr(inst, delslicestr);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001043 if (func == NULL) {
1044 PyErr_Clear();
1045 if (delitemstr == NULL)
1046 delitemstr =
1047 PyString_InternFromString("__delitem__");
1048 func = instance_getattr(inst, delitemstr);
1049 if (func == NULL)
1050 return -1;
1051
1052 arg = Py_BuildValue("(N)",
1053 sliceobj_from_intint(i, j));
1054 } else
1055 arg = Py_BuildValue("(ii)", i, j);
Guido van Rossum2878a691996-08-09 20:53:24 +00001056 }
1057 else {
1058 if (setslicestr == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001059 setslicestr =
1060 PyString_InternFromString("__setslice__");
Guido van Rossum2878a691996-08-09 20:53:24 +00001061 func = instance_getattr(inst, setslicestr);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001062 if (func == NULL) {
1063 PyErr_Clear();
1064 if (setitemstr == NULL)
1065 setitemstr =
1066 PyString_InternFromString("__setitem__");
1067 func = instance_getattr(inst, setitemstr);
1068 if (func == NULL)
1069 return -1;
1070
1071 arg = Py_BuildValue("(NO)",
1072 sliceobj_from_intint(i, j), value);
1073 } else
1074 arg = Py_BuildValue("(iiO)", i, j, value);
Guido van Rossum2878a691996-08-09 20:53:24 +00001075 }
Guido van Rossum04691fc1992-08-12 15:35:34 +00001076 if (arg == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001077 Py_DECREF(func);
Guido van Rossum6d946f91992-08-14 13:49:30 +00001078 return -1;
Guido van Rossum04691fc1992-08-12 15:35:34 +00001079 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001080 res = PyEval_CallObject(func, arg);
1081 Py_DECREF(func);
1082 Py_DECREF(arg);
Guido van Rossum04691fc1992-08-12 15:35:34 +00001083 if (res == NULL)
1084 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001085 Py_DECREF(res);
Guido van Rossum04691fc1992-08-12 15:35:34 +00001086 return 0;
1087}
1088
Guido van Rossumee28c3a2000-02-28 15:03:15 +00001089static int instance_contains(PyInstanceObject *inst, PyObject *member)
1090{
1091 static PyObject *__contains__;
1092 PyObject *func, *arg, *res;
1093 int ret;
1094
1095 if(__contains__ == NULL) {
1096 __contains__ = PyString_InternFromString("__contains__");
1097 if(__contains__ == NULL)
1098 return -1;
1099 }
1100 func = instance_getattr(inst, __contains__);
1101 if(func == NULL) {
Thomas Wouters7e474022000-07-16 12:04:32 +00001102 /* fall back to previous behavior */
Guido van Rossumee28c3a2000-02-28 15:03:15 +00001103 int i, cmp_res;
1104
1105 if(!PyErr_ExceptionMatches(PyExc_AttributeError))
1106 return -1;
1107 PyErr_Clear();
1108 for(i=0;;i++) {
1109 PyObject *obj = instance_item(inst, i);
1110 int ret = 0;
1111
1112 if(obj == NULL) {
1113 if(!PyErr_ExceptionMatches(PyExc_IndexError))
1114 return -1;
1115 PyErr_Clear();
1116 return 0;
1117 }
1118 if(PyObject_Cmp(obj, member, &cmp_res) == -1)
1119 ret = -1;
1120 if(cmp_res == 0)
1121 ret = 1;
1122 Py_DECREF(obj);
1123 if(ret)
1124 return ret;
1125 }
1126 }
1127 arg = Py_BuildValue("(O)", member);
1128 if(arg == NULL) {
1129 Py_DECREF(func);
1130 return -1;
1131 }
1132 res = PyEval_CallObject(func, arg);
1133 Py_DECREF(func);
1134 Py_DECREF(arg);
1135 if(res == NULL)
1136 return -1;
1137 ret = PyObject_IsTrue(res);
1138 Py_DECREF(res);
1139 return ret;
1140}
1141
Fred Drake79912472000-07-09 04:06:11 +00001142static PySequenceMethods
1143instance_as_sequence = {
Guido van Rossumb6775db1994-08-01 11:34:53 +00001144 (inquiry)instance_length, /*sq_length*/
Guido van Rossum03093a21994-09-28 15:51:32 +00001145 0, /*sq_concat*/
1146 0, /*sq_repeat*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001147 (intargfunc)instance_item, /*sq_item*/
1148 (intintargfunc)instance_slice, /*sq_slice*/
1149 (intobjargproc)instance_ass_item, /*sq_ass_item*/
1150 (intintobjargproc)instance_ass_slice, /*sq_ass_slice*/
Guido van Rossumee28c3a2000-02-28 15:03:15 +00001151 (objobjproc)instance_contains, /* sq_contains */
Guido van Rossum04691fc1992-08-12 15:35:34 +00001152};
1153
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001154static PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001155generic_unary_op(PyInstanceObject *self, PyObject *methodname)
Guido van Rossum04691fc1992-08-12 15:35:34 +00001156{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001157 PyObject *func, *res;
Guido van Rossum04691fc1992-08-12 15:35:34 +00001158
1159 if ((func = instance_getattr(self, methodname)) == NULL)
1160 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001161 res = PyEval_CallObject(func, (PyObject *)NULL);
1162 Py_DECREF(func);
Guido van Rossum04691fc1992-08-12 15:35:34 +00001163 return res;
1164}
1165
Guido van Rossum03093a21994-09-28 15:51:32 +00001166
Guido van Rossum03093a21994-09-28 15:51:32 +00001167/* Implement a binary operator involving at least one class instance. */
1168
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001169PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001170PyInstance_DoBinOp(PyObject *v, PyObject *w, char *opname, char *ropname,
1171 PyObject * (*thisfunc)(PyObject *, PyObject *))
Guido van Rossum03093a21994-09-28 15:51:32 +00001172{
1173 char buf[256];
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001174 PyObject *result = NULL;
Barry Warsawdc55d712000-08-18 04:57:32 +00001175
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001176 if (PyInstance_HalfBinOp(v, w, opname, &result, thisfunc, 0) <= 0)
Guido van Rossum03093a21994-09-28 15:51:32 +00001177 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001178 if (PyInstance_HalfBinOp(w, v, ropname, &result, thisfunc, 1) <= 0)
Guido van Rossum03093a21994-09-28 15:51:32 +00001179 return result;
Thomas Wouters7e474022000-07-16 12:04:32 +00001180 /* Sigh -- special case for comparisons */
Guido van Rossumc8b6df91997-05-23 00:06:51 +00001181 if (strcmp(opname, "__cmp__") == 0) {
Barry Warsawdc55d712000-08-18 04:57:32 +00001182 Py_uintptr_t iv = (Py_uintptr_t)v;
1183 Py_uintptr_t iw = (Py_uintptr_t)w;
1184 long c = (iv < iw) ? -1 : (iv > iw) ? 1 : 0;
Guido van Rossumc8b6df91997-05-23 00:06:51 +00001185 return PyInt_FromLong(c);
1186 }
Guido van Rossum03093a21994-09-28 15:51:32 +00001187 sprintf(buf, "%s nor %s defined for these operands", opname, ropname);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001188 PyErr_SetString(PyExc_TypeError, buf);
Guido van Rossum03093a21994-09-28 15:51:32 +00001189 return NULL;
Guido van Rossum04691fc1992-08-12 15:35:34 +00001190}
1191
Guido van Rossum03093a21994-09-28 15:51:32 +00001192
1193/* Try one half of a binary operator involving a class instance.
1194 Return value:
1195 -1 if an exception is to be reported right away
1196 0 if we have a valid result
1197 1 if we could try another operation
1198*/
1199
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001200static PyObject *coerce_obj;
Guido van Rossum2878a691996-08-09 20:53:24 +00001201
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001202int
1203PyInstance_HalfBinOp(PyObject *v, PyObject *w, char *opname, PyObject **r_result,
1204 PyObject * (*thisfunc)(PyObject *, PyObject *), int swapped)
Guido van Rossum03093a21994-09-28 15:51:32 +00001205{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001206 PyObject *func;
1207 PyObject *args;
Guido van Rossum3931df91997-11-18 19:23:07 +00001208 PyObject *coercefunc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001209 PyObject *coerced = NULL;
1210 PyObject *v1;
Guido van Rossum03093a21994-09-28 15:51:32 +00001211
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001212 if (!PyInstance_Check(v))
Guido van Rossum03093a21994-09-28 15:51:32 +00001213 return 1;
Guido van Rossum2878a691996-08-09 20:53:24 +00001214 if (coerce_obj == NULL) {
Guido van Rossuma412d241997-01-18 07:59:12 +00001215 coerce_obj = PyString_InternFromString("__coerce__");
Guido van Rossum2878a691996-08-09 20:53:24 +00001216 if (coerce_obj == NULL)
1217 return -1;
1218 }
Guido van Rossum3931df91997-11-18 19:23:07 +00001219 coercefunc = PyObject_GetAttr(v, coerce_obj);
1220 if (coercefunc == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001221 PyErr_Clear();
Guido van Rossum03093a21994-09-28 15:51:32 +00001222 }
1223 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001224 args = Py_BuildValue("(O)", w);
Guido van Rossum03093a21994-09-28 15:51:32 +00001225 if (args == NULL) {
Guido van Rossum03093a21994-09-28 15:51:32 +00001226 return -1;
1227 }
Guido van Rossum3931df91997-11-18 19:23:07 +00001228 coerced = PyEval_CallObject(coercefunc, args);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001229 Py_DECREF(args);
Guido van Rossum3931df91997-11-18 19:23:07 +00001230 Py_DECREF(coercefunc);
Guido van Rossum03093a21994-09-28 15:51:32 +00001231 if (coerced == NULL) {
Guido van Rossum03093a21994-09-28 15:51:32 +00001232 return -1;
1233 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001234 if (coerced == Py_None) {
1235 Py_DECREF(coerced);
Guido van Rossum03093a21994-09-28 15:51:32 +00001236 return 1;
1237 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001238 if (!PyTuple_Check(coerced) || PyTuple_Size(coerced) != 2) {
1239 Py_DECREF(coerced);
1240 PyErr_SetString(PyExc_TypeError,
Guido van Rossume7d444f1995-01-07 12:35:18 +00001241 "coercion should return None or 2-tuple");
Guido van Rossum03093a21994-09-28 15:51:32 +00001242 return -1;
1243 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001244 v1 = PyTuple_GetItem(coerced, 0);
1245 w = PyTuple_GetItem(coerced, 1);
Guido van Rossum03093a21994-09-28 15:51:32 +00001246 if (v1 != v) {
1247 v = v1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001248 if (!PyInstance_Check(v) && !PyInstance_Check(w)) {
Guido van Rossume7d444f1995-01-07 12:35:18 +00001249 if (swapped)
1250 *r_result = (*thisfunc)(w, v);
1251 else
1252 *r_result = (*thisfunc)(v, w);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001253 Py_DECREF(coerced);
Guido van Rossume7d444f1995-01-07 12:35:18 +00001254 return *r_result == NULL ? -1 : 0;
Guido van Rossum03093a21994-09-28 15:51:32 +00001255 }
1256 }
Guido van Rossum03093a21994-09-28 15:51:32 +00001257 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001258 func = PyObject_GetAttrString(v, opname);
Guido van Rossume7d444f1995-01-07 12:35:18 +00001259 if (func == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001260 Py_XDECREF(coerced);
Guido van Rossum617c1b01998-05-28 19:50:02 +00001261 if (!PyErr_ExceptionMatches(PyExc_AttributeError))
Guido van Rossume7d444f1995-01-07 12:35:18 +00001262 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001263 PyErr_Clear();
Guido van Rossume7d444f1995-01-07 12:35:18 +00001264 return 1;
1265 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001266 args = Py_BuildValue("(O)", w);
Guido van Rossum03093a21994-09-28 15:51:32 +00001267 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001268 Py_DECREF(func);
1269 Py_XDECREF(coerced);
Guido van Rossum03093a21994-09-28 15:51:32 +00001270 return -1;
1271 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001272 *r_result = PyEval_CallObject(func, args);
1273 Py_DECREF(args);
1274 Py_DECREF(func);
1275 Py_XDECREF(coerced);
Guido van Rossum03093a21994-09-28 15:51:32 +00001276 return *r_result == NULL ? -1 : 0;
1277}
1278
Guido van Rossum879c5811995-01-10 15:24:06 +00001279static int
Fred Drake79912472000-07-09 04:06:11 +00001280instance_coerce(PyObject **pv, PyObject **pw)
Guido van Rossum879c5811995-01-10 15:24:06 +00001281{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001282 PyObject *v = *pv;
1283 PyObject *w = *pw;
Guido van Rossum3931df91997-11-18 19:23:07 +00001284 PyObject *coercefunc;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001285 PyObject *args;
1286 PyObject *coerced;
Guido van Rossum879c5811995-01-10 15:24:06 +00001287
Guido van Rossum2878a691996-08-09 20:53:24 +00001288 if (coerce_obj == NULL) {
Guido van Rossuma412d241997-01-18 07:59:12 +00001289 coerce_obj = PyString_InternFromString("__coerce__");
Guido van Rossum2878a691996-08-09 20:53:24 +00001290 if (coerce_obj == NULL)
1291 return -1;
1292 }
Guido van Rossum3931df91997-11-18 19:23:07 +00001293 coercefunc = PyObject_GetAttr(v, coerce_obj);
1294 if (coercefunc == NULL) {
Guido van Rossum879c5811995-01-10 15:24:06 +00001295 /* No __coerce__ method: always OK */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001296 PyErr_Clear();
1297 Py_INCREF(v);
1298 Py_INCREF(w);
Guido van Rossum879c5811995-01-10 15:24:06 +00001299 return 0;
1300 }
1301 /* Has __coerce__ method: call it */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001302 args = Py_BuildValue("(O)", w);
Guido van Rossum879c5811995-01-10 15:24:06 +00001303 if (args == NULL) {
1304 return -1;
1305 }
Guido van Rossum3931df91997-11-18 19:23:07 +00001306 coerced = PyEval_CallObject(coercefunc, args);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001307 Py_DECREF(args);
Guido van Rossum3931df91997-11-18 19:23:07 +00001308 Py_DECREF(coercefunc);
Guido van Rossum879c5811995-01-10 15:24:06 +00001309 if (coerced == NULL) {
1310 /* __coerce__ call raised an exception */
1311 return -1;
1312 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001313 if (coerced == Py_None) {
Guido van Rossum879c5811995-01-10 15:24:06 +00001314 /* __coerce__ says "I can't do it" */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001315 Py_DECREF(coerced);
Guido van Rossum879c5811995-01-10 15:24:06 +00001316 return 1;
1317 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001318 if (!PyTuple_Check(coerced) || PyTuple_Size(coerced) != 2) {
Guido van Rossum879c5811995-01-10 15:24:06 +00001319 /* __coerce__ return value is malformed */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001320 Py_DECREF(coerced);
1321 PyErr_SetString(PyExc_TypeError,
Guido van Rossum879c5811995-01-10 15:24:06 +00001322 "coercion should return None or 2-tuple");
1323 return -1;
1324 }
1325 /* __coerce__ returned two new values */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001326 *pv = PyTuple_GetItem(coerced, 0);
1327 *pw = PyTuple_GetItem(coerced, 1);
1328 Py_INCREF(*pv);
1329 Py_INCREF(*pw);
1330 Py_DECREF(coerced);
Guido van Rossum879c5811995-01-10 15:24:06 +00001331 return 0;
1332}
1333
Guido van Rossum03093a21994-09-28 15:51:32 +00001334
Guido van Rossum04691fc1992-08-12 15:35:34 +00001335#define UNARY(funcname, methodname) \
Thomas Woutersc3073522000-07-23 22:09:59 +00001336static PyObject *funcname(PyInstanceObject *self) { \
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001337 static PyObject *o; \
Guido van Rossuma412d241997-01-18 07:59:12 +00001338 if (o == NULL) o = PyString_InternFromString(methodname); \
Guido van Rossum2878a691996-08-09 20:53:24 +00001339 return generic_unary_op(self, o); \
Guido van Rossum04691fc1992-08-12 15:35:34 +00001340}
1341
Guido van Rossum04691fc1992-08-12 15:35:34 +00001342UNARY(instance_neg, "__neg__")
1343UNARY(instance_pos, "__pos__")
1344UNARY(instance_abs, "__abs__")
1345
Guido van Rossum9bfef441993-03-29 10:43:31 +00001346static int
Fred Drake79912472000-07-09 04:06:11 +00001347instance_nonzero(PyInstanceObject *self)
Guido van Rossum04691fc1992-08-12 15:35:34 +00001348{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001349 PyObject *func, *res;
Guido van Rossum04691fc1992-08-12 15:35:34 +00001350 long outcome;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001351 static PyObject *nonzerostr;
Guido van Rossum04691fc1992-08-12 15:35:34 +00001352
Guido van Rossum2878a691996-08-09 20:53:24 +00001353 if (nonzerostr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +00001354 nonzerostr = PyString_InternFromString("__nonzero__");
Guido van Rossum2878a691996-08-09 20:53:24 +00001355 if ((func = instance_getattr(self, nonzerostr)) == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001356 PyErr_Clear();
Guido van Rossum2878a691996-08-09 20:53:24 +00001357 if (lenstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +00001358 lenstr = PyString_InternFromString("__len__");
Guido van Rossum2878a691996-08-09 20:53:24 +00001359 if ((func = instance_getattr(self, lenstr)) == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001360 PyErr_Clear();
Guido van Rossum04691fc1992-08-12 15:35:34 +00001361 /* Fall back to the default behavior:
1362 all instances are nonzero */
1363 return 1;
1364 }
1365 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001366 res = PyEval_CallObject(func, (PyObject *)NULL);
1367 Py_DECREF(func);
Guido van Rossum04691fc1992-08-12 15:35:34 +00001368 if (res == NULL)
1369 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001370 if (!PyInt_Check(res)) {
1371 Py_DECREF(res);
1372 PyErr_SetString(PyExc_TypeError,
1373 "__nonzero__ should return an int");
Guido van Rossum04691fc1992-08-12 15:35:34 +00001374 return -1;
1375 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001376 outcome = PyInt_AsLong(res);
1377 Py_DECREF(res);
Guido van Rossum04691fc1992-08-12 15:35:34 +00001378 if (outcome < 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001379 PyErr_SetString(PyExc_ValueError,
1380 "__nonzero__ should return >= 0");
Guido van Rossum04691fc1992-08-12 15:35:34 +00001381 return -1;
1382 }
1383 return outcome > 0;
1384}
1385
1386UNARY(instance_invert, "__invert__")
Guido van Rossum1899c2e1992-09-12 11:09:23 +00001387UNARY(instance_int, "__int__")
1388UNARY(instance_long, "__long__")
1389UNARY(instance_float, "__float__")
1390UNARY(instance_oct, "__oct__")
1391UNARY(instance_hex, "__hex__")
1392
Guido van Rossum03093a21994-09-28 15:51:32 +00001393/* This version is for ternary calls only (z != None) */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001394static PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001395instance_pow(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossum03093a21994-09-28 15:51:32 +00001396{
1397 /* XXX Doesn't do coercions... */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001398 PyObject *func;
1399 PyObject *args;
1400 PyObject *result;
1401 static PyObject *powstr;
Guido van Rossum2878a691996-08-09 20:53:24 +00001402
1403 if (powstr == NULL)
Guido van Rossuma412d241997-01-18 07:59:12 +00001404 powstr = PyString_InternFromString("__pow__");
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001405 func = PyObject_GetAttr(v, powstr);
Guido van Rossum03093a21994-09-28 15:51:32 +00001406 if (func == NULL)
1407 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001408 args = Py_BuildValue("(OO)", w, z);
Guido van Rossum03093a21994-09-28 15:51:32 +00001409 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001410 Py_DECREF(func);
Guido van Rossum03093a21994-09-28 15:51:32 +00001411 return NULL;
1412 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001413 result = PyEval_CallObject(func, args);
1414 Py_DECREF(func);
1415 Py_DECREF(args);
Guido van Rossum03093a21994-09-28 15:51:32 +00001416 return result;
1417}
1418
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001419static PyObject *
1420instance_inplace_pow(PyObject *v, PyObject *w, PyObject *z)
1421{
1422 /* XXX Doesn't do coercions... */
1423 PyObject *func;
1424 PyObject *args;
1425 PyObject *result;
1426 static PyObject *ipowstr;
1427
1428 if (ipowstr == NULL)
1429 ipowstr = PyString_InternFromString("__ipow__");
1430 func = PyObject_GetAttr(v, ipowstr);
1431 if (func == NULL) {
1432 if (!PyErr_ExceptionMatches(PyExc_AttributeError))
1433 return NULL;
Thomas Wouters1de2a792000-08-25 10:47:46 +00001434 PyErr_Clear();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001435 return instance_pow(v, w, z);
1436 }
1437 args = Py_BuildValue("(OO)", w, z);
1438 if (args == NULL) {
1439 Py_DECREF(func);
1440 return NULL;
1441 }
1442 result = PyEval_CallObject(func, args);
1443 Py_DECREF(func);
1444 Py_DECREF(args);
1445 return result;
1446}
1447
1448
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001449static PyNumberMethods instance_as_number = {
Guido van Rossum03093a21994-09-28 15:51:32 +00001450 0, /*nb_add*/
1451 0, /*nb_subtract*/
1452 0, /*nb_multiply*/
1453 0, /*nb_divide*/
1454 0, /*nb_remainder*/
1455 0, /*nb_divmod*/
Guido van Rossum52ca98a1994-09-05 07:32:29 +00001456 (ternaryfunc)instance_pow, /*nb_power*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001457 (unaryfunc)instance_neg, /*nb_negative*/
1458 (unaryfunc)instance_pos, /*nb_positive*/
1459 (unaryfunc)instance_abs, /*nb_absolute*/
1460 (inquiry)instance_nonzero, /*nb_nonzero*/
1461 (unaryfunc)instance_invert, /*nb_invert*/
Guido van Rossum03093a21994-09-28 15:51:32 +00001462 0, /*nb_lshift*/
1463 0, /*nb_rshift*/
1464 0, /*nb_and*/
1465 0, /*nb_xor*/
1466 0, /*nb_or*/
Guido van Rossum879c5811995-01-10 15:24:06 +00001467 (coercion)instance_coerce, /*nb_coerce*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001468 (unaryfunc)instance_int, /*nb_int*/
1469 (unaryfunc)instance_long, /*nb_long*/
1470 (unaryfunc)instance_float, /*nb_float*/
1471 (unaryfunc)instance_oct, /*nb_oct*/
1472 (unaryfunc)instance_hex, /*nb_hex*/
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001473 0, /*nb_inplace_add*/
1474 0, /*nb_inplace_subtract*/
1475 0, /*nb_inplace_multiply*/
1476 0, /*nb_inplace_divide*/
1477 0, /*nb_inplace_remainder*/
1478 (ternaryfunc)instance_inplace_pow, /*nb_inplace_power*/
1479 0, /*nb_inplace_lshift*/
1480 0, /*nb_inplace_rshift*/
1481 0, /*nb_inplace_and*/
1482 0, /*nb_inplace_xor*/
1483 0, /*nb_inplace_or*/
Guido van Rossum04691fc1992-08-12 15:35:34 +00001484};
1485
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001486PyTypeObject PyInstance_Type = {
1487 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001488 0,
Guido van Rossum21ed88c1991-04-04 10:42:10 +00001489 "instance",
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +00001490 sizeof(PyInstanceObject) + PyGC_HEAD_SIZE,
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001491 0,
Guido van Rossumb6775db1994-08-01 11:34:53 +00001492 (destructor)instance_dealloc, /*tp_dealloc*/
Guido van Rossum7066dd71992-09-17 17:54:56 +00001493 0, /*tp_print*/
Guido van Rossum2878a691996-08-09 20:53:24 +00001494 0, /*tp_getattr*/
1495 0, /*tp_setattr*/
1496 instance_compare, /*tp_compare*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001497 (reprfunc)instance_repr, /*tp_repr*/
Guido van Rossum04691fc1992-08-12 15:35:34 +00001498 &instance_as_number, /*tp_as_number*/
1499 &instance_as_sequence, /*tp_as_sequence*/
1500 &instance_as_mapping, /*tp_as_mapping*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001501 (hashfunc)instance_hash, /*tp_hash*/
Guido van Rossum2878a691996-08-09 20:53:24 +00001502 0, /*tp_call*/
1503 0, /*tp_str*/
1504 (getattrofunc)instance_getattr, /*tp_getattro*/
1505 (setattrofunc)instance_setattr, /*tp_setattro*/
Guido van Rossumee28c3a2000-02-28 15:03:15 +00001506 0, /* tp_as_buffer */
Jeremy Hyltond08b4c42000-06-23 19:37:02 +00001507 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_GC, /*tp_flags*/
Jeremy Hylton8caad492000-06-23 14:18:11 +00001508 0, /* tp_doc */
1509 (traverseproc)instance_traverse, /* tp_traverse */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001510};
1511
1512
Guido van Rossum81daa321993-05-20 14:24:46 +00001513/* Instance method objects are used for two purposes:
1514 (a) as bound instance methods (returned by instancename.methodname)
1515 (b) as unbound methods (returned by ClassName.methodname)
1516 In case (b), im_self is NULL
1517*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001518
Guido van Rossuma0d349f1997-08-05 02:06:53 +00001519static PyMethodObject *free_list;
1520
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001521PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001522PyMethod_New(PyObject *func, PyObject *self, PyObject *class)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001523{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001524 register PyMethodObject *im;
Guido van Rossum7859f871998-07-08 14:58:16 +00001525 if (!PyCallable_Check(func)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001526 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001527 return NULL;
1528 }
Guido van Rossuma0d349f1997-08-05 02:06:53 +00001529 im = free_list;
1530 if (im != NULL) {
1531 free_list = (PyMethodObject *)(im->im_self);
Guido van Rossumb18618d2000-05-03 23:44:39 +00001532 PyObject_INIT(im, &PyMethod_Type);
Guido van Rossuma0d349f1997-08-05 02:06:53 +00001533 }
1534 else {
1535 im = PyObject_NEW(PyMethodObject, &PyMethod_Type);
1536 if (im == NULL)
1537 return NULL;
1538 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001539 Py_INCREF(func);
Guido van Rossume8122f11991-05-05 20:03:07 +00001540 im->im_func = func;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001541 Py_XINCREF(self);
Guido van Rossume8122f11991-05-05 20:03:07 +00001542 im->im_self = self;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001543 Py_INCREF(class);
Guido van Rossum81daa321993-05-20 14:24:46 +00001544 im->im_class = class;
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +00001545 PyObject_GC_Init(im);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001546 return (PyObject *)im;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001547}
1548
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001549PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001550PyMethod_Function(register PyObject *im)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001551{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001552 if (!PyMethod_Check(im)) {
1553 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001554 return NULL;
1555 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001556 return ((PyMethodObject *)im)->im_func;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001557}
1558
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001559PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001560PyMethod_Self(register PyObject *im)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001561{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001562 if (!PyMethod_Check(im)) {
1563 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001564 return NULL;
1565 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001566 return ((PyMethodObject *)im)->im_self;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001567}
1568
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001569PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001570PyMethod_Class(register PyObject *im)
Guido van Rossum81daa321993-05-20 14:24:46 +00001571{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001572 if (!PyMethod_Check(im)) {
1573 PyErr_BadInternalCall();
Guido van Rossum81daa321993-05-20 14:24:46 +00001574 return NULL;
1575 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001576 return ((PyMethodObject *)im)->im_class;
Guido van Rossum81daa321993-05-20 14:24:46 +00001577}
1578
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001579/* Class method methods */
1580
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001581#define OFF(x) offsetof(PyMethodObject, x)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001582
Guido van Rossume8122f11991-05-05 20:03:07 +00001583static struct memberlist instancemethod_memberlist[] = {
1584 {"im_func", T_OBJECT, OFF(im_func)},
1585 {"im_self", T_OBJECT, OFF(im_self)},
Guido van Rossum81daa321993-05-20 14:24:46 +00001586 {"im_class", T_OBJECT, OFF(im_class)},
Guido van Rossum6dabc981996-05-14 21:54:20 +00001587 /* Dummies that are not handled by getattr() except for __members__ */
1588 {"__doc__", T_INT, 0},
1589 {"__name__", T_INT, 0},
Guido van Rossum3f5da241990-12-20 15:06:42 +00001590 {NULL} /* Sentinel */
1591};
1592
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001593static PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001594instancemethod_getattr(register PyMethodObject *im, PyObject *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +00001595{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001596 char *sname = PyString_AsString(name);
Guido van Rossum2878a691996-08-09 20:53:24 +00001597 if (sname[0] == '_') {
Guido van Rossum7859f871998-07-08 14:58:16 +00001598 /* Inherit __name__ and __doc__ from the callable object
1599 implementing the method */
1600 if (strcmp(sname, "__name__") == 0 ||
1601 strcmp(sname, "__doc__") == 0)
1602 return PyObject_GetAttr(im->im_func, name);
Guido van Rossum6dabc981996-05-14 21:54:20 +00001603 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001604 if (PyEval_GetRestricted()) {
1605 PyErr_SetString(PyExc_RuntimeError,
1606 "instance-method attributes not accessible in restricted mode");
Guido van Rossum10393b11995-01-10 10:39:49 +00001607 return NULL;
1608 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001609 return PyMember_Get((char *)im, instancemethod_memberlist, sname);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001610}
1611
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001612static void
Fred Drake79912472000-07-09 04:06:11 +00001613instancemethod_dealloc(register PyMethodObject *im)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001614{
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +00001615 PyObject_GC_Fini(im);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001616 Py_DECREF(im->im_func);
1617 Py_XDECREF(im->im_self);
1618 Py_DECREF(im->im_class);
Guido van Rossuma0d349f1997-08-05 02:06:53 +00001619 im->im_self = (PyObject *)free_list;
1620 free_list = im;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001621}
1622
Guido van Rossumebc8c511992-09-03 20:39:51 +00001623static int
Fred Drake79912472000-07-09 04:06:11 +00001624instancemethod_compare(PyMethodObject *a, PyMethodObject *b)
Guido van Rossumebc8c511992-09-03 20:39:51 +00001625{
Guido van Rossume9df7271995-04-06 14:46:51 +00001626 if (a->im_self != b->im_self)
1627 return (a->im_self < b->im_self) ? -1 : 1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001628 return PyObject_Compare(a->im_func, b->im_func);
Guido van Rossumebc8c511992-09-03 20:39:51 +00001629}
1630
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001631static PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001632instancemethod_repr(PyMethodObject *a)
Guido van Rossum25831651993-05-19 14:50:45 +00001633{
1634 char buf[240];
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001635 PyInstanceObject *self = (PyInstanceObject *)(a->im_self);
Guido van Rossum7859f871998-07-08 14:58:16 +00001636 PyObject *func = a->im_func;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001637 PyClassObject *class = (PyClassObject *)(a->im_class);
1638 PyObject *fclassname, *iclassname, *funcname;
Guido van Rossum81daa321993-05-20 14:24:46 +00001639 char *fcname, *icname, *fname;
1640 fclassname = class->cl_name;
Guido van Rossum7859f871998-07-08 14:58:16 +00001641 if (PyFunction_Check(func)) {
1642 funcname = ((PyFunctionObject *)func)->func_name;
1643 Py_INCREF(funcname);
1644 }
1645 else {
1646 funcname = PyObject_GetAttrString(func,"__name__");
1647 if (funcname == NULL)
1648 PyErr_Clear();
1649 }
1650 if (funcname != NULL && PyString_Check(funcname))
1651 fname = PyString_AS_STRING(funcname);
1652 else
1653 fname = "?";
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001654 if (fclassname != NULL && PyString_Check(fclassname))
1655 fcname = PyString_AsString(fclassname);
Guido van Rossum25831651993-05-19 14:50:45 +00001656 else
Guido van Rossum81daa321993-05-20 14:24:46 +00001657 fcname = "?";
Guido van Rossum81daa321993-05-20 14:24:46 +00001658 if (self == NULL)
1659 sprintf(buf, "<unbound method %.100s.%.100s>", fcname, fname);
1660 else {
1661 iclassname = self->in_class->cl_name;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001662 if (iclassname != NULL && PyString_Check(iclassname))
1663 icname = PyString_AsString(iclassname);
Guido van Rossum81daa321993-05-20 14:24:46 +00001664 else
1665 icname = "?";
Fred Drakea44d3532000-06-30 15:01:00 +00001666 sprintf(buf, "<method %.60s.%.60s of %.60s instance at %p>",
1667 fcname, fname, icname, self);
Guido van Rossum81daa321993-05-20 14:24:46 +00001668 }
Guido van Rossum42636dc1999-10-11 14:03:12 +00001669 Py_XDECREF(funcname);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001670 return PyString_FromString(buf);
Guido van Rossum25831651993-05-19 14:50:45 +00001671}
1672
Guido van Rossum9bfef441993-03-29 10:43:31 +00001673static long
Fred Drake79912472000-07-09 04:06:11 +00001674instancemethod_hash(PyMethodObject *a)
Guido van Rossum9bfef441993-03-29 10:43:31 +00001675{
1676 long x, y;
Guido van Rossum81daa321993-05-20 14:24:46 +00001677 if (a->im_self == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001678 x = PyObject_Hash(Py_None);
Guido van Rossum81daa321993-05-20 14:24:46 +00001679 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001680 x = PyObject_Hash(a->im_self);
Guido van Rossum9bfef441993-03-29 10:43:31 +00001681 if (x == -1)
1682 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001683 y = PyObject_Hash(a->im_func);
Guido van Rossum9bfef441993-03-29 10:43:31 +00001684 if (y == -1)
1685 return -1;
1686 return x ^ y;
1687}
1688
Jeremy Hylton8caad492000-06-23 14:18:11 +00001689static int
1690instancemethod_traverse(PyMethodObject *im, visitproc visit, void *arg)
1691{
1692 int err;
1693 if (im->im_func) {
1694 err = visit(im->im_func, arg);
1695 if (err)
1696 return err;
1697 }
1698 if (im->im_self) {
1699 err = visit(im->im_self, arg);
1700 if (err)
1701 return err;
1702 }
1703 if (im->im_class) {
1704 err = visit(im->im_class, arg);
1705 if (err)
1706 return err;
1707 }
Jeremy Hyltond22162b2000-06-23 17:14:56 +00001708 return 0;
Jeremy Hylton8caad492000-06-23 14:18:11 +00001709}
1710
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001711PyTypeObject PyMethod_Type = {
1712 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001713 0,
Guido van Rossum569fce71991-04-16 08:38:43 +00001714 "instance method",
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +00001715 sizeof(PyMethodObject) + PyGC_HEAD_SIZE,
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001716 0,
Guido van Rossumb6775db1994-08-01 11:34:53 +00001717 (destructor)instancemethod_dealloc, /*tp_dealloc*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001718 0, /*tp_print*/
Guido van Rossum2878a691996-08-09 20:53:24 +00001719 0, /*tp_getattr*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001720 0, /*tp_setattr*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001721 (cmpfunc)instancemethod_compare, /*tp_compare*/
1722 (reprfunc)instancemethod_repr, /*tp_repr*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001723 0, /*tp_as_number*/
1724 0, /*tp_as_sequence*/
1725 0, /*tp_as_mapping*/
Guido van Rossumb6775db1994-08-01 11:34:53 +00001726 (hashfunc)instancemethod_hash, /*tp_hash*/
Guido van Rossum2878a691996-08-09 20:53:24 +00001727 0, /*tp_call*/
1728 0, /*tp_str*/
1729 (getattrofunc)instancemethod_getattr, /*tp_getattro*/
1730 0, /*tp_setattro*/
Jeremy Hylton8caad492000-06-23 14:18:11 +00001731 0, /* tp_as_buffer */
Jeremy Hyltond08b4c42000-06-23 19:37:02 +00001732 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_GC, /*tp_flags*/
Jeremy Hylton8caad492000-06-23 14:18:11 +00001733 0, /* tp_doc */
1734 (traverseproc)instancemethod_traverse, /* tp_traverse */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001735};
Guido van Rossuma0d349f1997-08-05 02:06:53 +00001736
1737/* Clear out the free list */
1738
1739void
Fred Drake79912472000-07-09 04:06:11 +00001740PyMethod_Fini(void)
Guido van Rossuma0d349f1997-08-05 02:06:53 +00001741{
1742 while (free_list) {
Guido van Rossumb18618d2000-05-03 23:44:39 +00001743 PyMethodObject *im = free_list;
1744 free_list = (PyMethodObject *)(im->im_self);
Guido van Rossum4cc6ac72000-07-01 01:00:38 +00001745 im = (PyMethodObject *) PyObject_AS_GC(im);
Guido van Rossumb18618d2000-05-03 23:44:39 +00001746 PyObject_DEL(im);
Guido van Rossuma0d349f1997-08-05 02:06:53 +00001747 }
1748}