blob: a1f325de58f48fc2f2b9a7b9d82026bf8b5cea5f [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Method object implementation */
3
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Guido van Rossum1f39c5c1997-08-05 02:11:41 +00006static PyCFunctionObject *free_list = NULL;
7
Guido van Rossumc0b618a1997-05-02 03:12:38 +00008PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +00009PyCFunction_New(PyMethodDef *ml, PyObject *self)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000010{
Guido van Rossum1f39c5c1997-08-05 02:11:41 +000011 PyCFunctionObject *op;
12 op = free_list;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000013 if (op != NULL) {
Guido van Rossum1f39c5c1997-08-05 02:11:41 +000014 free_list = (PyCFunctionObject *)(op->m_self);
Guido van Rossumb18618d2000-05-03 23:44:39 +000015 PyObject_INIT(op, &PyCFunction_Type);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000016 }
Guido van Rossum1f39c5c1997-08-05 02:11:41 +000017 else {
Neil Schemenauerd91eec92002-03-18 20:44:53 +000018 op = PyObject_GC_New(PyCFunctionObject, &PyCFunction_Type);
Guido van Rossum1f39c5c1997-08-05 02:11:41 +000019 if (op == NULL)
20 return NULL;
21 }
22 op->m_ml = ml;
23 Py_XINCREF(self);
24 op->m_self = self;
Neil Schemenauerd91eec92002-03-18 20:44:53 +000025 _PyObject_GC_TRACK(op);
Guido van Rossumc0b618a1997-05-02 03:12:38 +000026 return (PyObject *)op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000027}
28
Guido van Rossumc0b618a1997-05-02 03:12:38 +000029PyCFunction
Fred Drakeee238b92000-07-09 06:03:25 +000030PyCFunction_GetFunction(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000032 if (!PyCFunction_Check(op)) {
33 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000034 return NULL;
35 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +000036 return ((PyCFunctionObject *)op) -> m_ml -> ml_meth;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000037}
38
Guido van Rossumc0b618a1997-05-02 03:12:38 +000039PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +000040PyCFunction_GetSelf(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000041{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000042 if (!PyCFunction_Check(op)) {
43 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000044 return NULL;
45 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +000046 return ((PyCFunctionObject *)op) -> m_self;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000047}
48
Guido van Rossumc0602291991-12-16 13:07:24 +000049int
Fred Drakeee238b92000-07-09 06:03:25 +000050PyCFunction_GetFlags(PyObject *op)
Guido van Rossumc0602291991-12-16 13:07:24 +000051{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000052 if (!PyCFunction_Check(op)) {
53 PyErr_BadInternalCall();
Guido van Rossumc0602291991-12-16 13:07:24 +000054 return -1;
55 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +000056 return ((PyCFunctionObject *)op) -> m_ml -> ml_flags;
Guido van Rossumc0602291991-12-16 13:07:24 +000057}
58
Jeremy Hylton910d7d42001-08-12 21:52:24 +000059PyObject *
60PyCFunction_Call(PyObject *func, PyObject *arg, PyObject *kw)
61{
62 PyCFunctionObject* f = (PyCFunctionObject*)func;
63 PyCFunction meth = PyCFunction_GET_FUNCTION(func);
64 PyObject *self = PyCFunction_GET_SELF(func);
Raymond Hettingerbf43f8a2003-01-04 00:37:53 +000065 int size;
Jeremy Hylton910d7d42001-08-12 21:52:24 +000066
Raymond Hettingerbf43f8a2003-01-04 00:37:53 +000067 switch (PyCFunction_GET_FLAGS(func) & ~(METH_CLASS | METH_STATIC)) {
Martin v. Löwise3eb1f22001-08-16 13:15:00 +000068 case METH_VARARGS:
Raymond Hettingerbf43f8a2003-01-04 00:37:53 +000069 if (kw == NULL || PyDict_Size(kw) == 0)
70 return (*meth)(self, arg);
71 break;
72 case METH_VARARGS | METH_KEYWORDS:
Tim Peters541ceec2003-01-05 07:22:44 +000073 case METH_OLDARGS | METH_KEYWORDS:
Raymond Hettingerbf43f8a2003-01-04 00:37:53 +000074 return (*(PyCFunctionWithKeywords)meth)(self, arg, kw);
Martin v. Löwise3eb1f22001-08-16 13:15:00 +000075 case METH_NOARGS:
Raymond Hettingerbf43f8a2003-01-04 00:37:53 +000076 if (kw == NULL || PyDict_Size(kw) == 0) {
77 size = PyTuple_GET_SIZE(arg);
78 if (size == 0)
79 return (*meth)(self, NULL);
80 PyErr_Format(PyExc_TypeError,
81 "%.200s() takes no arguments (%d given)",
82 f->m_ml->ml_name, size);
83 return NULL;
84 }
85 break;
Martin v. Löwise3eb1f22001-08-16 13:15:00 +000086 case METH_O:
Raymond Hettingerbf43f8a2003-01-04 00:37:53 +000087 if (kw == NULL || PyDict_Size(kw) == 0) {
88 size = PyTuple_GET_SIZE(arg);
89 if (size == 1)
90 return (*meth)(self, PyTuple_GET_ITEM(arg, 0));
91 PyErr_Format(PyExc_TypeError,
92 "%.200s() takes exactly one argument (%d given)",
93 f->m_ml->ml_name, size);
94 return NULL;
95 }
96 break;
Martin v. Löwise3eb1f22001-08-16 13:15:00 +000097 case METH_OLDARGS:
Jeremy Hylton910d7d42001-08-12 21:52:24 +000098 /* the really old style */
Raymond Hettingerbf43f8a2003-01-04 00:37:53 +000099 if (kw == NULL || PyDict_Size(kw) == 0) {
100 size = PyTuple_GET_SIZE(arg);
101 if (size == 1)
102 arg = PyTuple_GET_ITEM(arg, 0);
103 else if (size == 0)
104 arg = NULL;
105 return (*meth)(self, arg);
106 }
107 break;
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000108 default:
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000109 PyErr_BadInternalCall();
110 return NULL;
Jeremy Hylton910d7d42001-08-12 21:52:24 +0000111 }
Raymond Hettingerbf43f8a2003-01-04 00:37:53 +0000112 PyErr_Format(PyExc_TypeError, "%.200s() takes no keyword arguments",
113 f->m_ml->ml_name);
114 return NULL;
Jeremy Hylton910d7d42001-08-12 21:52:24 +0000115}
116
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000117/* Methods (the standard built-in methods, that is) */
118
119static void
Fred Drakeee238b92000-07-09 06:03:25 +0000120meth_dealloc(PyCFunctionObject *m)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000121{
Neil Schemenauerd91eec92002-03-18 20:44:53 +0000122 _PyObject_GC_UNTRACK(m);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000123 Py_XDECREF(m->m_self);
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000124 m->m_self = (PyObject *)free_list;
125 free_list = m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000126}
127
Tim Peters6d6c1a32001-08-02 04:15:00 +0000128static PyObject *
129meth_get__doc__(PyCFunctionObject *m, void *closure)
130{
131 char *doc = m->m_ml->ml_doc;
132
133 if (doc != NULL)
134 return PyString_FromString(doc);
135 Py_INCREF(Py_None);
136 return Py_None;
137}
138
139static PyObject *
140meth_get__name__(PyCFunctionObject *m, void *closure)
141{
142 return PyString_FromString(m->m_ml->ml_name);
143}
144
Neil Schemenauer10c66922001-07-12 13:27:35 +0000145static int
146meth_traverse(PyCFunctionObject *m, visitproc visit, void *arg)
147{
148 if (m->m_self != NULL)
149 return visit(m->m_self, arg);
150 else
151 return 0;
152}
153
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000154static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000155meth_get__self__(PyCFunctionObject *m, void *closure)
Guido van Rossumcab650d1995-01-07 12:34:58 +0000156{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000157 PyObject *self;
158 if (PyEval_GetRestricted()) {
159 PyErr_SetString(PyExc_RuntimeError,
160 "method.__self__ not accessible in restricted mode");
161 return NULL;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000162 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000163 self = m->m_self;
164 if (self == NULL)
165 self = Py_None;
166 Py_INCREF(self);
167 return self;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000168}
169
Guido van Rossum32d34c82001-09-20 21:45:26 +0000170static PyGetSetDef meth_getsets [] = {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000171 {"__doc__", (getter)meth_get__doc__, NULL, NULL},
172 {"__name__", (getter)meth_get__name__, NULL, NULL},
173 {"__self__", (getter)meth_get__self__, NULL, NULL},
174 {0}
175};
176
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000177static PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000178meth_repr(PyCFunctionObject *m)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000179{
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000180 if (m->m_self == NULL)
Barry Warsaw7ce36942001-08-24 18:34:26 +0000181 return PyString_FromFormat("<built-in function %s>",
182 m->m_ml->ml_name);
183 return PyString_FromFormat("<built-in method %s of %s object at %p>",
184 m->m_ml->ml_name,
185 m->m_self->ob_type->tp_name,
186 m->m_self);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000187}
188
Guido van Rossum9bfef441993-03-29 10:43:31 +0000189static int
Fred Drakeee238b92000-07-09 06:03:25 +0000190meth_compare(PyCFunctionObject *a, PyCFunctionObject *b)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000191{
192 if (a->m_self != b->m_self)
Guido van Rossum13fdf5e1998-12-04 18:52:55 +0000193 return (a->m_self < b->m_self) ? -1 : 1;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000194 if (a->m_ml->ml_meth == b->m_ml->ml_meth)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000195 return 0;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000196 if (strcmp(a->m_ml->ml_name, b->m_ml->ml_name) < 0)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000197 return -1;
198 else
199 return 1;
200}
201
202static long
Fred Drakeee238b92000-07-09 06:03:25 +0000203meth_hash(PyCFunctionObject *a)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000204{
Fred Drake13634cf2000-06-29 19:17:04 +0000205 long x,y;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000206 if (a->m_self == NULL)
207 x = 0;
208 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000209 x = PyObject_Hash(a->m_self);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000210 if (x == -1)
211 return -1;
212 }
Guido van Rossum9a15c212000-06-30 22:46:04 +0000213 y = _Py_HashPointer((void*)(a->m_ml->ml_meth));
Fred Drake13634cf2000-06-29 19:17:04 +0000214 if (y == -1)
215 return -1;
216 x ^= y;
217 if (x == -1)
218 x = -2;
219 return x;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000220}
221
Tim Peters6d6c1a32001-08-02 04:15:00 +0000222
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000223PyTypeObject PyCFunction_Type = {
224 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000225 0,
Guido van Rossum7066dd71992-09-17 17:54:56 +0000226 "builtin_function_or_method",
Neil Schemenauerd91eec92002-03-18 20:44:53 +0000227 sizeof(PyCFunctionObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000228 0,
Neil Schemenauer10c66922001-07-12 13:27:35 +0000229 (destructor)meth_dealloc, /* tp_dealloc */
230 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000231 0, /* tp_getattr */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000232 0, /* tp_setattr */
233 (cmpfunc)meth_compare, /* tp_compare */
234 (reprfunc)meth_repr, /* tp_repr */
235 0, /* tp_as_number */
236 0, /* tp_as_sequence */
237 0, /* tp_as_mapping */
238 (hashfunc)meth_hash, /* tp_hash */
Jeremy Hylton910d7d42001-08-12 21:52:24 +0000239 PyCFunction_Call, /* tp_call */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000240 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000241 PyObject_GenericGetAttr, /* tp_getattro */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000242 0, /* tp_setattro */
243 0, /* tp_as_buffer */
Neil Schemenauerd91eec92002-03-18 20:44:53 +0000244 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000245 0, /* tp_doc */
246 (traverseproc)meth_traverse, /* tp_traverse */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000247 0, /* tp_clear */
248 0, /* tp_richcompare */
249 0, /* tp_weaklistoffset */
250 0, /* tp_iter */
251 0, /* tp_iternext */
252 0, /* tp_methods */
253 0, /* tp_members */
254 meth_getsets, /* tp_getset */
255 0, /* tp_base */
256 0, /* tp_dict */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000257};
Guido van Rossum3f5da241990-12-20 15:06:42 +0000258
Guido van Rossum69785031995-01-26 22:58:48 +0000259/* List all methods in a chain -- helper for findmethodinchain */
Guido van Rossume9c430f1991-10-20 20:21:15 +0000260
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000261static PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000262listmethodchain(PyMethodChain *chain)
Guido van Rossume9c430f1991-10-20 20:21:15 +0000263{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000264 PyMethodChain *c;
265 PyMethodDef *ml;
Guido van Rossume9c430f1991-10-20 20:21:15 +0000266 int i, n;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000267 PyObject *v;
Tim Peters541ceec2003-01-05 07:22:44 +0000268
Guido van Rossum69785031995-01-26 22:58:48 +0000269 n = 0;
270 for (c = chain; c != NULL; c = c->link) {
271 for (ml = c->methods; ml->ml_name != NULL; ml++)
272 n++;
273 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000274 v = PyList_New(n);
Guido van Rossum69785031995-01-26 22:58:48 +0000275 if (v == NULL)
276 return NULL;
277 i = 0;
278 for (c = chain; c != NULL; c = c->link) {
279 for (ml = c->methods; ml->ml_name != NULL; ml++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000280 PyList_SetItem(v, i, PyString_FromString(ml->ml_name));
Guido van Rossum69785031995-01-26 22:58:48 +0000281 i++;
Guido van Rossume9c430f1991-10-20 20:21:15 +0000282 }
283 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000284 if (PyErr_Occurred()) {
285 Py_DECREF(v);
Guido van Rossum69785031995-01-26 22:58:48 +0000286 return NULL;
287 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000288 PyList_Sort(v);
Guido van Rossume9c430f1991-10-20 20:21:15 +0000289 return v;
290}
291
Guido van Rossum69785031995-01-26 22:58:48 +0000292/* Find a method in a method chain */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000293
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000294PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000295Py_FindMethodInChain(PyMethodChain *chain, PyObject *self, char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000296{
Guido van Rossum8a92c621998-06-27 18:28:59 +0000297 if (name[0] == '_' && name[1] == '_') {
298 if (strcmp(name, "__methods__") == 0)
299 return listmethodchain(chain);
300 if (strcmp(name, "__doc__") == 0) {
301 char *doc = self->ob_type->tp_doc;
302 if (doc != NULL)
303 return PyString_FromString(doc);
304 }
305 }
Guido van Rossum69785031995-01-26 22:58:48 +0000306 while (chain != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000307 PyMethodDef *ml = chain->methods;
Guido van Rossum69785031995-01-26 22:58:48 +0000308 for (; ml->ml_name != NULL; ml++) {
309 if (name[0] == ml->ml_name[0] &&
310 strcmp(name+1, ml->ml_name+1) == 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000311 return PyCFunction_New(ml, self);
Guido van Rossum69785031995-01-26 22:58:48 +0000312 }
313 chain = chain->link;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000314 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000315 PyErr_SetString(PyExc_AttributeError, name);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000316 return NULL;
317}
Guido van Rossum69785031995-01-26 22:58:48 +0000318
319/* Find a method in a single method list */
320
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000321PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000322Py_FindMethod(PyMethodDef *methods, PyObject *self, char *name)
Guido van Rossum69785031995-01-26 22:58:48 +0000323{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000324 PyMethodChain chain;
Guido van Rossum69785031995-01-26 22:58:48 +0000325 chain.methods = methods;
326 chain.link = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000327 return Py_FindMethodInChain(&chain, self, name);
Guido van Rossum69785031995-01-26 22:58:48 +0000328}
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000329
330/* Clear out the free list */
331
332void
Fred Drakeee238b92000-07-09 06:03:25 +0000333PyCFunction_Fini(void)
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000334{
335 while (free_list) {
336 PyCFunctionObject *v = free_list;
337 free_list = (PyCFunctionObject *)(v->m_self);
Neil Schemenauerd91eec92002-03-18 20:44:53 +0000338 PyObject_GC_Del(v);
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000339 }
340}