blob: cdba3505f9b0426e4accf85ca7c083b537595e7e [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 {
18 op = PyObject_NEW(PyCFunctionObject, &PyCFunction_Type);
19 if (op == NULL)
20 return NULL;
21 }
22 op->m_ml = ml;
23 Py_XINCREF(self);
24 op->m_self = self;
Neil Schemenauer10c66922001-07-12 13:27:35 +000025 PyObject_GC_Init(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);
65 int flags = PyCFunction_GET_FLAGS(func);
Martin v. Löwise3eb1f22001-08-16 13:15:00 +000066 int size = PyTuple_GET_SIZE(arg);
Jeremy Hylton910d7d42001-08-12 21:52:24 +000067
68 if (flags & METH_KEYWORDS) {
69 return (*(PyCFunctionWithKeywords)meth)(self, arg, kw);
70 }
71 if (kw != NULL && PyDict_Size(kw) != 0) {
72 PyErr_Format(PyExc_TypeError,
73 "%.200s() takes no keyword arguments",
74 f->m_ml->ml_name);
75 return NULL;
76 }
Martin v. Löwise3eb1f22001-08-16 13:15:00 +000077
78 switch (flags) {
79 case METH_VARARGS:
Jeremy Hylton910d7d42001-08-12 21:52:24 +000080 return (*meth)(self, arg);
Martin v. Löwise3eb1f22001-08-16 13:15:00 +000081 break;
82 case METH_NOARGS:
83 if (size == 0)
84 return (*meth)(self, NULL);
85 PyErr_Format(PyExc_TypeError,
86 "%.200s() takes no arguments (%d given)",
87 f->m_ml->ml_name, size);
88 return NULL;
89 break;
90 case METH_O:
91 if (size == 1)
92 return (*meth)(self, PyTuple_GET_ITEM(arg, 0));
93 PyErr_Format(PyExc_TypeError,
94 "%.200s() takes exactly one argument (%d given)",
95 f->m_ml->ml_name, size);
96 return NULL;
97 break;
98 case METH_OLDARGS:
Jeremy Hylton910d7d42001-08-12 21:52:24 +000099 /* the really old style */
Jeremy Hylton910d7d42001-08-12 21:52:24 +0000100 if (size == 1)
101 arg = PyTuple_GET_ITEM(arg, 0);
102 else if (size == 0)
103 arg = NULL;
104 return (*meth)(self, arg);
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000105 default:
106 /* should never get here ??? */
107 PyErr_BadInternalCall();
108 return NULL;
Jeremy Hylton910d7d42001-08-12 21:52:24 +0000109 }
Jeremy Hylton910d7d42001-08-12 21:52:24 +0000110}
111
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000112/* Methods (the standard built-in methods, that is) */
113
114static void
Fred Drakeee238b92000-07-09 06:03:25 +0000115meth_dealloc(PyCFunctionObject *m)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000116{
Neil Schemenauer10c66922001-07-12 13:27:35 +0000117 PyObject_GC_Fini(m);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000118 Py_XDECREF(m->m_self);
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000119 m->m_self = (PyObject *)free_list;
120 free_list = m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000121}
122
Tim Peters6d6c1a32001-08-02 04:15:00 +0000123static PyObject *
124meth_get__doc__(PyCFunctionObject *m, void *closure)
125{
126 char *doc = m->m_ml->ml_doc;
127
128 if (doc != NULL)
129 return PyString_FromString(doc);
130 Py_INCREF(Py_None);
131 return Py_None;
132}
133
134static PyObject *
135meth_get__name__(PyCFunctionObject *m, void *closure)
136{
137 return PyString_FromString(m->m_ml->ml_name);
138}
139
Neil Schemenauer10c66922001-07-12 13:27:35 +0000140static int
141meth_traverse(PyCFunctionObject *m, visitproc visit, void *arg)
142{
143 if (m->m_self != NULL)
144 return visit(m->m_self, arg);
145 else
146 return 0;
147}
148
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000149static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000150meth_get__self__(PyCFunctionObject *m, void *closure)
Guido van Rossumcab650d1995-01-07 12:34:58 +0000151{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000152 PyObject *self;
153 if (PyEval_GetRestricted()) {
154 PyErr_SetString(PyExc_RuntimeError,
155 "method.__self__ not accessible in restricted mode");
156 return NULL;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000157 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000158 self = m->m_self;
159 if (self == NULL)
160 self = Py_None;
161 Py_INCREF(self);
162 return self;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000163}
164
Tim Peters6d6c1a32001-08-02 04:15:00 +0000165static struct getsetlist meth_getsets [] = {
166 {"__doc__", (getter)meth_get__doc__, NULL, NULL},
167 {"__name__", (getter)meth_get__name__, NULL, NULL},
168 {"__self__", (getter)meth_get__self__, NULL, NULL},
169 {0}
170};
171
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000172static PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000173meth_repr(PyCFunctionObject *m)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000174{
175 char buf[200];
176 if (m->m_self == NULL)
Guido van Rossumcab650d1995-01-07 12:34:58 +0000177 sprintf(buf, "<built-in function %.80s>", m->m_ml->ml_name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000178 else
Guido van Rossum3f5da241990-12-20 15:06:42 +0000179 sprintf(buf,
Fred Drakea44d3532000-06-30 15:01:00 +0000180 "<built-in method %.80s of %.80s object at %p>",
Guido van Rossumcab650d1995-01-07 12:34:58 +0000181 m->m_ml->ml_name, m->m_self->ob_type->tp_name,
Fred Drakea44d3532000-06-30 15:01:00 +0000182 m->m_self);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000183 return PyString_FromString(buf);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000184}
185
Guido van Rossum9bfef441993-03-29 10:43:31 +0000186static int
Fred Drakeee238b92000-07-09 06:03:25 +0000187meth_compare(PyCFunctionObject *a, PyCFunctionObject *b)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000188{
189 if (a->m_self != b->m_self)
Guido van Rossum13fdf5e1998-12-04 18:52:55 +0000190 return (a->m_self < b->m_self) ? -1 : 1;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000191 if (a->m_ml->ml_meth == b->m_ml->ml_meth)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000192 return 0;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000193 if (strcmp(a->m_ml->ml_name, b->m_ml->ml_name) < 0)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000194 return -1;
195 else
196 return 1;
197}
198
199static long
Fred Drakeee238b92000-07-09 06:03:25 +0000200meth_hash(PyCFunctionObject *a)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000201{
Fred Drake13634cf2000-06-29 19:17:04 +0000202 long x,y;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000203 if (a->m_self == NULL)
204 x = 0;
205 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000206 x = PyObject_Hash(a->m_self);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000207 if (x == -1)
208 return -1;
209 }
Guido van Rossum9a15c212000-06-30 22:46:04 +0000210 y = _Py_HashPointer((void*)(a->m_ml->ml_meth));
Fred Drake13634cf2000-06-29 19:17:04 +0000211 if (y == -1)
212 return -1;
213 x ^= y;
214 if (x == -1)
215 x = -2;
216 return x;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000217}
218
Tim Peters6d6c1a32001-08-02 04:15:00 +0000219
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000220PyTypeObject PyCFunction_Type = {
221 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000222 0,
Guido van Rossum7066dd71992-09-17 17:54:56 +0000223 "builtin_function_or_method",
Neil Schemenauer10c66922001-07-12 13:27:35 +0000224 sizeof(PyCFunctionObject) + PyGC_HEAD_SIZE,
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000225 0,
Neil Schemenauer10c66922001-07-12 13:27:35 +0000226 (destructor)meth_dealloc, /* tp_dealloc */
227 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000228 0, /* tp_getattr */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000229 0, /* tp_setattr */
230 (cmpfunc)meth_compare, /* tp_compare */
231 (reprfunc)meth_repr, /* tp_repr */
232 0, /* tp_as_number */
233 0, /* tp_as_sequence */
234 0, /* tp_as_mapping */
235 (hashfunc)meth_hash, /* tp_hash */
Jeremy Hylton910d7d42001-08-12 21:52:24 +0000236 PyCFunction_Call, /* tp_call */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000237 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000238 PyObject_GenericGetAttr, /* tp_getattro */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000239 0, /* tp_setattro */
240 0, /* tp_as_buffer */
241 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_GC, /* tp_flags */
242 0, /* tp_doc */
243 (traverseproc)meth_traverse, /* tp_traverse */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000244 0, /* tp_clear */
245 0, /* tp_richcompare */
246 0, /* tp_weaklistoffset */
247 0, /* tp_iter */
248 0, /* tp_iternext */
249 0, /* tp_methods */
250 0, /* tp_members */
251 meth_getsets, /* tp_getset */
252 0, /* tp_base */
253 0, /* tp_dict */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000254};
Guido van Rossum3f5da241990-12-20 15:06:42 +0000255
Guido van Rossum69785031995-01-26 22:58:48 +0000256/* List all methods in a chain -- helper for findmethodinchain */
Guido van Rossume9c430f1991-10-20 20:21:15 +0000257
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000258static PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000259listmethodchain(PyMethodChain *chain)
Guido van Rossume9c430f1991-10-20 20:21:15 +0000260{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000261 PyMethodChain *c;
262 PyMethodDef *ml;
Guido van Rossume9c430f1991-10-20 20:21:15 +0000263 int i, n;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000264 PyObject *v;
Guido van Rossum69785031995-01-26 22:58:48 +0000265
266 n = 0;
267 for (c = chain; c != NULL; c = c->link) {
268 for (ml = c->methods; ml->ml_name != NULL; ml++)
269 n++;
270 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000271 v = PyList_New(n);
Guido van Rossum69785031995-01-26 22:58:48 +0000272 if (v == NULL)
273 return NULL;
274 i = 0;
275 for (c = chain; c != NULL; c = c->link) {
276 for (ml = c->methods; ml->ml_name != NULL; ml++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000277 PyList_SetItem(v, i, PyString_FromString(ml->ml_name));
Guido van Rossum69785031995-01-26 22:58:48 +0000278 i++;
Guido van Rossume9c430f1991-10-20 20:21:15 +0000279 }
280 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000281 if (PyErr_Occurred()) {
282 Py_DECREF(v);
Guido van Rossum69785031995-01-26 22:58:48 +0000283 return NULL;
284 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000285 PyList_Sort(v);
Guido van Rossume9c430f1991-10-20 20:21:15 +0000286 return v;
287}
288
Guido van Rossum69785031995-01-26 22:58:48 +0000289/* Find a method in a method chain */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000290
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000291PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000292Py_FindMethodInChain(PyMethodChain *chain, PyObject *self, char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000293{
Guido van Rossum8a92c621998-06-27 18:28:59 +0000294 if (name[0] == '_' && name[1] == '_') {
295 if (strcmp(name, "__methods__") == 0)
296 return listmethodchain(chain);
297 if (strcmp(name, "__doc__") == 0) {
298 char *doc = self->ob_type->tp_doc;
299 if (doc != NULL)
300 return PyString_FromString(doc);
301 }
302 }
Guido van Rossum69785031995-01-26 22:58:48 +0000303 while (chain != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000304 PyMethodDef *ml = chain->methods;
Guido van Rossum69785031995-01-26 22:58:48 +0000305 for (; ml->ml_name != NULL; ml++) {
306 if (name[0] == ml->ml_name[0] &&
307 strcmp(name+1, ml->ml_name+1) == 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000308 return PyCFunction_New(ml, self);
Guido van Rossum69785031995-01-26 22:58:48 +0000309 }
310 chain = chain->link;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000311 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000312 PyErr_SetString(PyExc_AttributeError, name);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000313 return NULL;
314}
Guido van Rossum69785031995-01-26 22:58:48 +0000315
316/* Find a method in a single method list */
317
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000318PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000319Py_FindMethod(PyMethodDef *methods, PyObject *self, char *name)
Guido van Rossum69785031995-01-26 22:58:48 +0000320{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000321 PyMethodChain chain;
Guido van Rossum69785031995-01-26 22:58:48 +0000322 chain.methods = methods;
323 chain.link = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000324 return Py_FindMethodInChain(&chain, self, name);
Guido van Rossum69785031995-01-26 22:58:48 +0000325}
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000326
327/* Clear out the free list */
328
329void
Fred Drakeee238b92000-07-09 06:03:25 +0000330PyCFunction_Fini(void)
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000331{
332 while (free_list) {
333 PyCFunctionObject *v = free_list;
334 free_list = (PyCFunctionObject *)(v->m_self);
Neil Schemenauer10c66922001-07-12 13:27:35 +0000335 v = (PyCFunctionObject *) PyObject_AS_GC(v);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000336 PyObject_DEL(v);
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000337 }
338}