Guido van Rossum | 50e9fb9 | 2006-08-17 05:42:55 +0000 | [diff] [blame] | 1 | /* Class object implementation (dead now except for methods) */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 2 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 3 | #include "Python.h" |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 4 | #include "structmember.h" |
Guido van Rossum | 04691fc | 1992-08-12 15:35:34 +0000 | [diff] [blame] | 5 | |
Guido van Rossum | 3cf5b1e | 2006-07-27 21:53:35 +0000 | [diff] [blame] | 6 | #define TP_DESCR_GET(t) ((t)->tp_descr_get) |
Guido van Rossum | 915f0eb | 2001-10-17 20:26:38 +0000 | [diff] [blame] | 7 | |
Christian Heimes | 2202f87 | 2008-02-06 14:31:34 +0000 | [diff] [blame] | 8 | /* Free list for method objects to safe malloc/free overhead |
| 9 | * The im_self element is used to chain the elements. |
| 10 | */ |
| 11 | static PyMethodObject *free_list; |
| 12 | static int numfree = 0; |
| 13 | #ifndef PyMethod_MAXFREELIST |
| 14 | #define PyMethod_MAXFREELIST 256 |
| 15 | #endif |
| 16 | |
Guido van Rossum | b479dc5 | 2001-09-05 22:52:50 +0000 | [diff] [blame] | 17 | PyObject * |
| 18 | PyMethod_Function(PyObject *im) |
| 19 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 20 | if (!PyMethod_Check(im)) { |
| 21 | PyErr_BadInternalCall(); |
| 22 | return NULL; |
| 23 | } |
| 24 | return ((PyMethodObject *)im)->im_func; |
Guido van Rossum | b479dc5 | 2001-09-05 22:52:50 +0000 | [diff] [blame] | 25 | } |
| 26 | |
| 27 | PyObject * |
| 28 | PyMethod_Self(PyObject *im) |
| 29 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 30 | if (!PyMethod_Check(im)) { |
| 31 | PyErr_BadInternalCall(); |
| 32 | return NULL; |
| 33 | } |
| 34 | return ((PyMethodObject *)im)->im_self; |
Guido van Rossum | b479dc5 | 2001-09-05 22:52:50 +0000 | [diff] [blame] | 35 | } |
| 36 | |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 37 | /* Method objects are used for bound instance methods returned by |
| 38 | instancename.methodname. ClassName.methodname returns an ordinary |
| 39 | function. |
Guido van Rossum | 81daa32 | 1993-05-20 14:24:46 +0000 | [diff] [blame] | 40 | */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 41 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 42 | PyObject * |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 43 | PyMethod_New(PyObject *func, PyObject *self) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 44 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 45 | register PyMethodObject *im; |
| 46 | if (self == NULL) { |
| 47 | PyErr_BadInternalCall(); |
| 48 | return NULL; |
| 49 | } |
| 50 | im = free_list; |
| 51 | if (im != NULL) { |
| 52 | free_list = (PyMethodObject *)(im->im_self); |
| 53 | PyObject_INIT(im, &PyMethod_Type); |
| 54 | numfree--; |
| 55 | } |
| 56 | else { |
| 57 | im = PyObject_GC_New(PyMethodObject, &PyMethod_Type); |
| 58 | if (im == NULL) |
| 59 | return NULL; |
| 60 | } |
| 61 | im->im_weakreflist = NULL; |
| 62 | Py_INCREF(func); |
| 63 | im->im_func = func; |
| 64 | Py_XINCREF(self); |
| 65 | im->im_self = self; |
| 66 | _PyObject_GC_TRACK(im); |
| 67 | return (PyObject *)im; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 68 | } |
| 69 | |
Guido van Rossum | f0b35e1 | 2001-09-18 03:53:24 +0000 | [diff] [blame] | 70 | /* Descriptors for PyMethod attributes */ |
| 71 | |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 72 | /* im_func and im_self are stored in the PyMethod object */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 73 | |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 74 | #define MO_OFF(x) offsetof(PyMethodObject, x) |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 75 | |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 76 | static PyMemberDef method_memberlist[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 77 | {"__func__", T_OBJECT, MO_OFF(im_func), READONLY|RESTRICTED, |
| 78 | "the function (or other callable) implementing a method"}, |
| 79 | {"__self__", T_OBJECT, MO_OFF(im_self), READONLY|RESTRICTED, |
| 80 | "the instance to which a method is bound"}, |
| 81 | {NULL} /* Sentinel */ |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 82 | }; |
| 83 | |
Guido van Rossum | baf0f8f | 2003-11-22 23:55:50 +0000 | [diff] [blame] | 84 | /* Christian Tismer argued convincingly that method attributes should |
| 85 | (nearly) always override function attributes. |
| 86 | The one exception is __doc__; there's a default __doc__ which |
| 87 | should only be used for the class, not for instances */ |
| 88 | |
| 89 | static PyObject * |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 90 | method_get_doc(PyMethodObject *im, void *context) |
Guido van Rossum | baf0f8f | 2003-11-22 23:55:50 +0000 | [diff] [blame] | 91 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 92 | static PyObject *docstr; |
| 93 | if (docstr == NULL) { |
| 94 | docstr= PyUnicode_InternFromString("__doc__"); |
| 95 | if (docstr == NULL) |
| 96 | return NULL; |
| 97 | } |
| 98 | return PyObject_GetAttr(im->im_func, docstr); |
Guido van Rossum | baf0f8f | 2003-11-22 23:55:50 +0000 | [diff] [blame] | 99 | } |
| 100 | |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 101 | static PyGetSetDef method_getset[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 102 | {"__doc__", (getter)method_get_doc, NULL, NULL}, |
| 103 | {0} |
Guido van Rossum | baf0f8f | 2003-11-22 23:55:50 +0000 | [diff] [blame] | 104 | }; |
Guido van Rossum | f0b35e1 | 2001-09-18 03:53:24 +0000 | [diff] [blame] | 105 | |
| 106 | static PyObject * |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 107 | method_getattro(PyObject *obj, PyObject *name) |
Guido van Rossum | f0b35e1 | 2001-09-18 03:53:24 +0000 | [diff] [blame] | 108 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 109 | PyMethodObject *im = (PyMethodObject *)obj; |
| 110 | PyTypeObject *tp = obj->ob_type; |
| 111 | PyObject *descr = NULL; |
Guido van Rossum | f0b35e1 | 2001-09-18 03:53:24 +0000 | [diff] [blame] | 112 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 113 | { |
| 114 | if (tp->tp_dict == NULL) { |
| 115 | if (PyType_Ready(tp) < 0) |
| 116 | return NULL; |
| 117 | } |
| 118 | descr = _PyType_Lookup(tp, name); |
| 119 | } |
Guido van Rossum | f0b35e1 | 2001-09-18 03:53:24 +0000 | [diff] [blame] | 120 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 121 | if (descr != NULL) { |
| 122 | descrgetfunc f = TP_DESCR_GET(descr->ob_type); |
| 123 | if (f != NULL) |
| 124 | return f(descr, obj, (PyObject *)obj->ob_type); |
| 125 | else { |
| 126 | Py_INCREF(descr); |
| 127 | return descr; |
| 128 | } |
| 129 | } |
Guido van Rossum | f0b35e1 | 2001-09-18 03:53:24 +0000 | [diff] [blame] | 130 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 131 | return PyObject_GetAttr(im->im_func, name); |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 132 | } |
| 133 | |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 134 | PyDoc_STRVAR(method_doc, |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 135 | "method(function, instance)\n\ |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 136 | \n\ |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 137 | Create a bound instance method object."); |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 138 | |
| 139 | static PyObject * |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 140 | method_new(PyTypeObject* type, PyObject* args, PyObject *kw) |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 141 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 142 | PyObject *func; |
| 143 | PyObject *self; |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 144 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 145 | if (!_PyArg_NoKeywords("method", kw)) |
| 146 | return NULL; |
| 147 | if (!PyArg_UnpackTuple(args, "method", 2, 2, |
| 148 | &func, &self)) |
| 149 | return NULL; |
| 150 | if (!PyCallable_Check(func)) { |
| 151 | PyErr_SetString(PyExc_TypeError, |
| 152 | "first argument must be callable"); |
| 153 | return NULL; |
| 154 | } |
| 155 | if (self == NULL || self == Py_None) { |
| 156 | PyErr_SetString(PyExc_TypeError, |
| 157 | "self must not be None"); |
| 158 | return NULL; |
| 159 | } |
Michael W. Hudson | e2749cb | 2005-03-30 16:32:10 +0000 | [diff] [blame] | 160 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 161 | return PyMethod_New(func, self); |
Guido van Rossum | bea18cc | 2002-06-14 20:41:17 +0000 | [diff] [blame] | 162 | } |
| 163 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 164 | static void |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 165 | method_dealloc(register PyMethodObject *im) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 166 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 167 | _PyObject_GC_UNTRACK(im); |
| 168 | if (im->im_weakreflist != NULL) |
| 169 | PyObject_ClearWeakRefs((PyObject *)im); |
| 170 | Py_DECREF(im->im_func); |
| 171 | Py_XDECREF(im->im_self); |
| 172 | if (numfree < PyMethod_MAXFREELIST) { |
| 173 | im->im_self = (PyObject *)free_list; |
| 174 | free_list = im; |
| 175 | numfree++; |
| 176 | } |
| 177 | else { |
| 178 | PyObject_GC_Del(im); |
| 179 | } |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 180 | } |
| 181 | |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 182 | static PyObject * |
| 183 | method_richcompare(PyObject *self, PyObject *other, int op) |
Guido van Rossum | ebc8c51 | 1992-09-03 20:39:51 +0000 | [diff] [blame] | 184 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 185 | PyMethodObject *a, *b; |
| 186 | PyObject *res; |
| 187 | int eq; |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 188 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 189 | if ((op != Py_EQ && op != Py_NE) || |
| 190 | !PyMethod_Check(self) || |
| 191 | !PyMethod_Check(other)) |
| 192 | { |
| 193 | Py_INCREF(Py_NotImplemented); |
| 194 | return Py_NotImplemented; |
| 195 | } |
| 196 | a = (PyMethodObject *)self; |
| 197 | b = (PyMethodObject *)other; |
| 198 | eq = PyObject_RichCompareBool(a->im_func, b->im_func, Py_EQ); |
| 199 | if (eq == 1) { |
| 200 | if (a->im_self == NULL || b->im_self == NULL) |
| 201 | eq = a->im_self == b->im_self; |
| 202 | else |
| 203 | eq = PyObject_RichCompareBool(a->im_self, b->im_self, |
| 204 | Py_EQ); |
| 205 | } |
| 206 | if (eq < 0) |
| 207 | return NULL; |
| 208 | if (op == Py_EQ) |
| 209 | res = eq ? Py_True : Py_False; |
| 210 | else |
| 211 | res = eq ? Py_False : Py_True; |
| 212 | Py_INCREF(res); |
| 213 | return res; |
Guido van Rossum | ebc8c51 | 1992-09-03 20:39:51 +0000 | [diff] [blame] | 214 | } |
| 215 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 216 | static PyObject * |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 217 | method_repr(PyMethodObject *a) |
Guido van Rossum | 2583165 | 1993-05-19 14:50:45 +0000 | [diff] [blame] | 218 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 219 | PyObject *self = a->im_self; |
| 220 | PyObject *func = a->im_func; |
| 221 | PyObject *klass = (PyObject*)Py_TYPE(self); |
| 222 | PyObject *funcname = NULL ,*klassname = NULL, *result = NULL; |
| 223 | char *defname = "?"; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 224 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 225 | if (self == NULL) { |
| 226 | PyErr_BadInternalCall(); |
| 227 | return NULL; |
| 228 | } |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 229 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 230 | funcname = PyObject_GetAttrString(func, "__name__"); |
| 231 | if (funcname == NULL) { |
| 232 | if (!PyErr_ExceptionMatches(PyExc_AttributeError)) |
| 233 | return NULL; |
| 234 | PyErr_Clear(); |
| 235 | } |
| 236 | else if (!PyUnicode_Check(funcname)) { |
| 237 | Py_DECREF(funcname); |
| 238 | funcname = NULL; |
| 239 | } |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 240 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 241 | if (klass == NULL) |
| 242 | klassname = NULL; |
| 243 | else { |
| 244 | klassname = PyObject_GetAttrString(klass, "__name__"); |
| 245 | if (klassname == NULL) { |
Andrew Svetlov | ddcb620 | 2012-07-20 14:51:45 +0300 | [diff] [blame^] | 246 | if (!PyErr_ExceptionMatches(PyExc_AttributeError)) { |
| 247 | Py_XDECREF(funcname); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 248 | return NULL; |
Andrew Svetlov | ddcb620 | 2012-07-20 14:51:45 +0300 | [diff] [blame^] | 249 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 250 | PyErr_Clear(); |
| 251 | } |
| 252 | else if (!PyUnicode_Check(klassname)) { |
| 253 | Py_DECREF(klassname); |
| 254 | klassname = NULL; |
| 255 | } |
| 256 | } |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 257 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 258 | /* XXX Shouldn't use repr()/%R here! */ |
| 259 | result = PyUnicode_FromFormat("<bound method %V.%V of %R>", |
| 260 | klassname, defname, |
| 261 | funcname, defname, self); |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 262 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 263 | Py_XDECREF(funcname); |
| 264 | Py_XDECREF(klassname); |
| 265 | return result; |
Guido van Rossum | 2583165 | 1993-05-19 14:50:45 +0000 | [diff] [blame] | 266 | } |
| 267 | |
Benjamin Peterson | 8f67d08 | 2010-10-17 20:54:53 +0000 | [diff] [blame] | 268 | static Py_hash_t |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 269 | method_hash(PyMethodObject *a) |
Guido van Rossum | 9bfef44 | 1993-03-29 10:43:31 +0000 | [diff] [blame] | 270 | { |
Benjamin Peterson | 8f67d08 | 2010-10-17 20:54:53 +0000 | [diff] [blame] | 271 | Py_hash_t x, y; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 272 | if (a->im_self == NULL) |
| 273 | x = PyObject_Hash(Py_None); |
| 274 | else |
| 275 | x = PyObject_Hash(a->im_self); |
| 276 | if (x == -1) |
| 277 | return -1; |
| 278 | y = PyObject_Hash(a->im_func); |
| 279 | if (y == -1) |
| 280 | return -1; |
| 281 | x = x ^ y; |
| 282 | if (x == -1) |
| 283 | x = -2; |
| 284 | return x; |
Guido van Rossum | 9bfef44 | 1993-03-29 10:43:31 +0000 | [diff] [blame] | 285 | } |
| 286 | |
Jeremy Hylton | 8caad49 | 2000-06-23 14:18:11 +0000 | [diff] [blame] | 287 | static int |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 288 | method_traverse(PyMethodObject *im, visitproc visit, void *arg) |
Jeremy Hylton | 8caad49 | 2000-06-23 14:18:11 +0000 | [diff] [blame] | 289 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 290 | Py_VISIT(im->im_func); |
| 291 | Py_VISIT(im->im_self); |
| 292 | return 0; |
Jeremy Hylton | 8caad49 | 2000-06-23 14:18:11 +0000 | [diff] [blame] | 293 | } |
| 294 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 295 | static PyObject * |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 296 | method_call(PyObject *func, PyObject *arg, PyObject *kw) |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 297 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 298 | PyObject *self = PyMethod_GET_SELF(func); |
| 299 | PyObject *result; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 300 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 301 | func = PyMethod_GET_FUNCTION(func); |
| 302 | if (self == NULL) { |
| 303 | PyErr_BadInternalCall(); |
| 304 | return NULL; |
| 305 | } |
| 306 | else { |
| 307 | Py_ssize_t argcount = PyTuple_Size(arg); |
| 308 | PyObject *newarg = PyTuple_New(argcount + 1); |
| 309 | int i; |
| 310 | if (newarg == NULL) |
| 311 | return NULL; |
| 312 | Py_INCREF(self); |
| 313 | PyTuple_SET_ITEM(newarg, 0, self); |
| 314 | for (i = 0; i < argcount; i++) { |
| 315 | PyObject *v = PyTuple_GET_ITEM(arg, i); |
| 316 | Py_XINCREF(v); |
| 317 | PyTuple_SET_ITEM(newarg, i+1, v); |
| 318 | } |
| 319 | arg = newarg; |
| 320 | } |
| 321 | result = PyObject_Call((PyObject *)func, arg, kw); |
| 322 | Py_DECREF(arg); |
| 323 | return result; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 324 | } |
| 325 | |
Guido van Rossum | 23cc2b4 | 2001-08-15 17:52:31 +0000 | [diff] [blame] | 326 | static PyObject * |
Guido van Rossum | 47b9ff6 | 2006-08-24 00:41:19 +0000 | [diff] [blame] | 327 | method_descr_get(PyObject *meth, PyObject *obj, PyObject *cls) |
Guido van Rossum | 23cc2b4 | 2001-08-15 17:52:31 +0000 | [diff] [blame] | 328 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 329 | /* Don't rebind an already bound method of a class that's not a base |
| 330 | class of cls. */ |
| 331 | if (PyMethod_GET_SELF(meth) != NULL) { |
| 332 | /* Already bound */ |
| 333 | Py_INCREF(meth); |
| 334 | return meth; |
| 335 | } |
| 336 | /* Bind it to obj */ |
| 337 | return PyMethod_New(PyMethod_GET_FUNCTION(meth), obj); |
Guido van Rossum | 23cc2b4 | 2001-08-15 17:52:31 +0000 | [diff] [blame] | 338 | } |
| 339 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 340 | PyTypeObject PyMethod_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 341 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 342 | "method", |
| 343 | sizeof(PyMethodObject), |
| 344 | 0, |
| 345 | (destructor)method_dealloc, /* tp_dealloc */ |
| 346 | 0, /* tp_print */ |
| 347 | 0, /* tp_getattr */ |
| 348 | 0, /* tp_setattr */ |
| 349 | 0, /* tp_reserved */ |
| 350 | (reprfunc)method_repr, /* tp_repr */ |
| 351 | 0, /* tp_as_number */ |
| 352 | 0, /* tp_as_sequence */ |
| 353 | 0, /* tp_as_mapping */ |
| 354 | (hashfunc)method_hash, /* tp_hash */ |
| 355 | method_call, /* tp_call */ |
| 356 | 0, /* tp_str */ |
| 357 | method_getattro, /* tp_getattro */ |
| 358 | PyObject_GenericSetAttr, /* tp_setattro */ |
| 359 | 0, /* tp_as_buffer */ |
| 360 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ |
| 361 | method_doc, /* tp_doc */ |
| 362 | (traverseproc)method_traverse, /* tp_traverse */ |
| 363 | 0, /* tp_clear */ |
| 364 | method_richcompare, /* tp_richcompare */ |
| 365 | offsetof(PyMethodObject, im_weakreflist), /* tp_weaklistoffset */ |
| 366 | 0, /* tp_iter */ |
| 367 | 0, /* tp_iternext */ |
| 368 | 0, /* tp_methods */ |
| 369 | method_memberlist, /* tp_members */ |
| 370 | method_getset, /* tp_getset */ |
| 371 | 0, /* tp_base */ |
| 372 | 0, /* tp_dict */ |
| 373 | method_descr_get, /* tp_descr_get */ |
| 374 | 0, /* tp_descr_set */ |
| 375 | 0, /* tp_dictoffset */ |
| 376 | 0, /* tp_init */ |
| 377 | 0, /* tp_alloc */ |
| 378 | method_new, /* tp_new */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 379 | }; |
Guido van Rossum | a0d349f | 1997-08-05 02:06:53 +0000 | [diff] [blame] | 380 | |
| 381 | /* Clear out the free list */ |
| 382 | |
Christian Heimes | a156e09 | 2008-02-16 07:38:31 +0000 | [diff] [blame] | 383 | int |
| 384 | PyMethod_ClearFreeList(void) |
Guido van Rossum | a0d349f | 1997-08-05 02:06:53 +0000 | [diff] [blame] | 385 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 386 | int freelist_size = numfree; |
| 387 | |
| 388 | while (free_list) { |
| 389 | PyMethodObject *im = free_list; |
| 390 | free_list = (PyMethodObject *)(im->im_self); |
| 391 | PyObject_GC_Del(im); |
| 392 | numfree--; |
| 393 | } |
| 394 | assert(numfree == 0); |
| 395 | return freelist_size; |
Christian Heimes | a156e09 | 2008-02-16 07:38:31 +0000 | [diff] [blame] | 396 | } |
| 397 | |
| 398 | void |
| 399 | PyMethod_Fini(void) |
| 400 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 401 | (void)PyMethod_ClearFreeList(); |
Guido van Rossum | a0d349f | 1997-08-05 02:06:53 +0000 | [diff] [blame] | 402 | } |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 403 | |
| 404 | /* ------------------------------------------------------------------------ |
| 405 | * instance method |
| 406 | */ |
| 407 | |
| 408 | PyObject * |
| 409 | PyInstanceMethod_New(PyObject *func) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 410 | PyInstanceMethodObject *method; |
| 411 | method = PyObject_GC_New(PyInstanceMethodObject, |
| 412 | &PyInstanceMethod_Type); |
| 413 | if (method == NULL) return NULL; |
| 414 | Py_INCREF(func); |
| 415 | method->func = func; |
| 416 | _PyObject_GC_TRACK(method); |
| 417 | return (PyObject *)method; |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 418 | } |
| 419 | |
| 420 | PyObject * |
| 421 | PyInstanceMethod_Function(PyObject *im) |
| 422 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 423 | if (!PyInstanceMethod_Check(im)) { |
| 424 | PyErr_BadInternalCall(); |
| 425 | return NULL; |
| 426 | } |
| 427 | return PyInstanceMethod_GET_FUNCTION(im); |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 428 | } |
| 429 | |
| 430 | #define IMO_OFF(x) offsetof(PyInstanceMethodObject, x) |
| 431 | |
| 432 | static PyMemberDef instancemethod_memberlist[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 433 | {"__func__", T_OBJECT, IMO_OFF(func), READONLY|RESTRICTED, |
| 434 | "the function (or other callable) implementing a method"}, |
| 435 | {NULL} /* Sentinel */ |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 436 | }; |
| 437 | |
| 438 | static PyObject * |
| 439 | instancemethod_get_doc(PyObject *self, void *context) |
| 440 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 441 | static PyObject *docstr; |
| 442 | if (docstr == NULL) { |
| 443 | docstr = PyUnicode_InternFromString("__doc__"); |
| 444 | if (docstr == NULL) |
| 445 | return NULL; |
| 446 | } |
| 447 | return PyObject_GetAttr(PyInstanceMethod_GET_FUNCTION(self), docstr); |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 448 | } |
| 449 | |
| 450 | static PyGetSetDef instancemethod_getset[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 451 | {"__doc__", (getter)instancemethod_get_doc, NULL, NULL}, |
| 452 | {0} |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 453 | }; |
| 454 | |
| 455 | static PyObject * |
| 456 | instancemethod_getattro(PyObject *self, PyObject *name) |
| 457 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 458 | PyTypeObject *tp = self->ob_type; |
| 459 | PyObject *descr = NULL; |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 460 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 461 | if (tp->tp_dict == NULL) { |
| 462 | if (PyType_Ready(tp) < 0) |
| 463 | return NULL; |
| 464 | } |
| 465 | descr = _PyType_Lookup(tp, name); |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 466 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 467 | if (descr != NULL) { |
| 468 | descrgetfunc f = TP_DESCR_GET(descr->ob_type); |
| 469 | if (f != NULL) |
| 470 | return f(descr, self, (PyObject *)self->ob_type); |
| 471 | else { |
| 472 | Py_INCREF(descr); |
| 473 | return descr; |
| 474 | } |
| 475 | } |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 476 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 477 | return PyObject_GetAttr(PyInstanceMethod_GET_FUNCTION(self), name); |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 478 | } |
| 479 | |
| 480 | static void |
| 481 | instancemethod_dealloc(PyObject *self) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 482 | _PyObject_GC_UNTRACK(self); |
| 483 | Py_DECREF(PyInstanceMethod_GET_FUNCTION(self)); |
| 484 | PyObject_GC_Del(self); |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 485 | } |
| 486 | |
| 487 | static int |
| 488 | instancemethod_traverse(PyObject *self, visitproc visit, void *arg) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 489 | Py_VISIT(PyInstanceMethod_GET_FUNCTION(self)); |
| 490 | return 0; |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 491 | } |
| 492 | |
| 493 | static PyObject * |
| 494 | instancemethod_call(PyObject *self, PyObject *arg, PyObject *kw) |
| 495 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 496 | return PyObject_Call(PyMethod_GET_FUNCTION(self), arg, kw); |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 497 | } |
| 498 | |
| 499 | static PyObject * |
| 500 | instancemethod_descr_get(PyObject *descr, PyObject *obj, PyObject *type) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 501 | register PyObject *func = PyInstanceMethod_GET_FUNCTION(descr); |
| 502 | if (obj == NULL) { |
| 503 | Py_INCREF(func); |
| 504 | return func; |
| 505 | } |
| 506 | else |
| 507 | return PyMethod_New(func, obj); |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 508 | } |
| 509 | |
| 510 | static PyObject * |
| 511 | instancemethod_richcompare(PyObject *self, PyObject *other, int op) |
| 512 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 513 | PyInstanceMethodObject *a, *b; |
| 514 | PyObject *res; |
| 515 | int eq; |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 516 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 517 | if ((op != Py_EQ && op != Py_NE) || |
| 518 | !PyInstanceMethod_Check(self) || |
| 519 | !PyInstanceMethod_Check(other)) |
| 520 | { |
| 521 | Py_INCREF(Py_NotImplemented); |
| 522 | return Py_NotImplemented; |
| 523 | } |
| 524 | a = (PyInstanceMethodObject *)self; |
| 525 | b = (PyInstanceMethodObject *)other; |
| 526 | eq = PyObject_RichCompareBool(a->func, b->func, Py_EQ); |
| 527 | if (eq < 0) |
| 528 | return NULL; |
| 529 | if (op == Py_EQ) |
| 530 | res = eq ? Py_True : Py_False; |
| 531 | else |
| 532 | res = eq ? Py_False : Py_True; |
| 533 | Py_INCREF(res); |
| 534 | return res; |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 535 | } |
| 536 | |
| 537 | static PyObject * |
| 538 | instancemethod_repr(PyObject *self) |
| 539 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 540 | PyObject *func = PyInstanceMethod_Function(self); |
| 541 | PyObject *funcname = NULL , *result = NULL; |
| 542 | char *defname = "?"; |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 543 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 544 | if (func == NULL) { |
| 545 | PyErr_BadInternalCall(); |
| 546 | return NULL; |
| 547 | } |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 548 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 549 | funcname = PyObject_GetAttrString(func, "__name__"); |
| 550 | if (funcname == NULL) { |
| 551 | if (!PyErr_ExceptionMatches(PyExc_AttributeError)) |
| 552 | return NULL; |
| 553 | PyErr_Clear(); |
| 554 | } |
| 555 | else if (!PyUnicode_Check(funcname)) { |
| 556 | Py_DECREF(funcname); |
| 557 | funcname = NULL; |
| 558 | } |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 559 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 560 | result = PyUnicode_FromFormat("<instancemethod %V at %p>", |
| 561 | funcname, defname, self); |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 562 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 563 | Py_XDECREF(funcname); |
| 564 | return result; |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 565 | } |
| 566 | |
| 567 | /* |
| 568 | static long |
| 569 | instancemethod_hash(PyObject *self) |
| 570 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 571 | long x, y; |
| 572 | x = (long)self; |
| 573 | y = PyObject_Hash(PyInstanceMethod_GET_FUNCTION(self)); |
| 574 | if (y == -1) |
| 575 | return -1; |
| 576 | x = x ^ y; |
| 577 | if (x == -1) |
| 578 | x = -2; |
| 579 | return x; |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 580 | } |
| 581 | */ |
| 582 | |
| 583 | PyDoc_STRVAR(instancemethod_doc, |
| 584 | "instancemethod(function)\n\ |
| 585 | \n\ |
| 586 | Bind a function to a class."); |
| 587 | |
| 588 | static PyObject * |
| 589 | instancemethod_new(PyTypeObject* type, PyObject* args, PyObject *kw) |
| 590 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 591 | PyObject *func; |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 592 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 593 | if (!_PyArg_NoKeywords("instancemethod", kw)) |
| 594 | return NULL; |
| 595 | if (!PyArg_UnpackTuple(args, "instancemethod", 1, 1, &func)) |
| 596 | return NULL; |
| 597 | if (!PyCallable_Check(func)) { |
| 598 | PyErr_SetString(PyExc_TypeError, |
| 599 | "first argument must be callable"); |
| 600 | return NULL; |
| 601 | } |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 602 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 603 | return PyInstanceMethod_New(func); |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 604 | } |
| 605 | |
| 606 | PyTypeObject PyInstanceMethod_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 607 | PyVarObject_HEAD_INIT(&PyType_Type, 0) |
| 608 | "instancemethod", /* tp_name */ |
| 609 | sizeof(PyInstanceMethodObject), /* tp_basicsize */ |
| 610 | 0, /* tp_itemsize */ |
| 611 | instancemethod_dealloc, /* tp_dealloc */ |
| 612 | 0, /* tp_print */ |
| 613 | 0, /* tp_getattr */ |
| 614 | 0, /* tp_setattr */ |
| 615 | 0, /* tp_reserved */ |
| 616 | (reprfunc)instancemethod_repr, /* tp_repr */ |
| 617 | 0, /* tp_as_number */ |
| 618 | 0, /* tp_as_sequence */ |
| 619 | 0, /* tp_as_mapping */ |
| 620 | 0, /*(hashfunc)instancemethod_hash, tp_hash */ |
| 621 | instancemethod_call, /* tp_call */ |
| 622 | 0, /* tp_str */ |
| 623 | instancemethod_getattro, /* tp_getattro */ |
| 624 | PyObject_GenericSetAttr, /* tp_setattro */ |
| 625 | 0, /* tp_as_buffer */ |
| 626 | Py_TPFLAGS_DEFAULT |
| 627 | | Py_TPFLAGS_HAVE_GC, /* tp_flags */ |
| 628 | instancemethod_doc, /* tp_doc */ |
| 629 | instancemethod_traverse, /* tp_traverse */ |
| 630 | 0, /* tp_clear */ |
| 631 | instancemethod_richcompare, /* tp_richcompare */ |
| 632 | 0, /* tp_weaklistoffset */ |
| 633 | 0, /* tp_iter */ |
| 634 | 0, /* tp_iternext */ |
| 635 | 0, /* tp_methods */ |
| 636 | instancemethod_memberlist, /* tp_members */ |
| 637 | instancemethod_getset, /* tp_getset */ |
| 638 | 0, /* tp_base */ |
| 639 | 0, /* tp_dict */ |
| 640 | instancemethod_descr_get, /* tp_descr_get */ |
| 641 | 0, /* tp_descr_set */ |
| 642 | 0, /* tp_dictoffset */ |
| 643 | 0, /* tp_init */ |
| 644 | 0, /* tp_alloc */ |
| 645 | instancemethod_new, /* tp_new */ |
Christian Heimes | a3534a6 | 2007-12-11 19:56:40 +0000 | [diff] [blame] | 646 | }; |