blob: 0cb4fd88955c819fc166b92a54d46f4f48869a04 [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);
Fred Drake7bf97152002-03-28 05:33:33 +000065 int flags = PyCFunction_GET_FLAGS(func) & ~(METH_CLASS | METH_STATIC);
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 case METH_NOARGS:
82 if (size == 0)
83 return (*meth)(self, NULL);
84 PyErr_Format(PyExc_TypeError,
85 "%.200s() takes no arguments (%d given)",
86 f->m_ml->ml_name, size);
87 return NULL;
Martin v. Löwise3eb1f22001-08-16 13:15:00 +000088 case METH_O:
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;
Martin v. Löwise3eb1f22001-08-16 13:15:00 +000095 case METH_OLDARGS:
Jeremy Hylton910d7d42001-08-12 21:52:24 +000096 /* the really old style */
Jeremy Hylton910d7d42001-08-12 21:52:24 +000097 if (size == 1)
98 arg = PyTuple_GET_ITEM(arg, 0);
99 else if (size == 0)
100 arg = NULL;
101 return (*meth)(self, arg);
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000102 default:
103 /* should never get here ??? */
104 PyErr_BadInternalCall();
105 return NULL;
Jeremy Hylton910d7d42001-08-12 21:52:24 +0000106 }
Jeremy Hylton910d7d42001-08-12 21:52:24 +0000107}
108
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000109/* Methods (the standard built-in methods, that is) */
110
111static void
Fred Drakeee238b92000-07-09 06:03:25 +0000112meth_dealloc(PyCFunctionObject *m)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000113{
Neil Schemenauerd91eec92002-03-18 20:44:53 +0000114 _PyObject_GC_UNTRACK(m);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000115 Py_XDECREF(m->m_self);
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000116 m->m_self = (PyObject *)free_list;
117 free_list = m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000118}
119
Tim Peters6d6c1a32001-08-02 04:15:00 +0000120static PyObject *
121meth_get__doc__(PyCFunctionObject *m, void *closure)
122{
123 char *doc = m->m_ml->ml_doc;
124
125 if (doc != NULL)
126 return PyString_FromString(doc);
127 Py_INCREF(Py_None);
128 return Py_None;
129}
130
131static PyObject *
132meth_get__name__(PyCFunctionObject *m, void *closure)
133{
134 return PyString_FromString(m->m_ml->ml_name);
135}
136
Neil Schemenauer10c66922001-07-12 13:27:35 +0000137static int
138meth_traverse(PyCFunctionObject *m, visitproc visit, void *arg)
139{
140 if (m->m_self != NULL)
141 return visit(m->m_self, arg);
142 else
143 return 0;
144}
145
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000146static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000147meth_get__self__(PyCFunctionObject *m, void *closure)
Guido van Rossumcab650d1995-01-07 12:34:58 +0000148{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000149 PyObject *self;
150 if (PyEval_GetRestricted()) {
151 PyErr_SetString(PyExc_RuntimeError,
152 "method.__self__ not accessible in restricted mode");
153 return NULL;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000154 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000155 self = m->m_self;
156 if (self == NULL)
157 self = Py_None;
158 Py_INCREF(self);
159 return self;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000160}
161
Guido van Rossum32d34c82001-09-20 21:45:26 +0000162static PyGetSetDef meth_getsets [] = {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000163 {"__doc__", (getter)meth_get__doc__, NULL, NULL},
164 {"__name__", (getter)meth_get__name__, NULL, NULL},
165 {"__self__", (getter)meth_get__self__, NULL, NULL},
166 {0}
167};
168
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000169static PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000170meth_repr(PyCFunctionObject *m)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000171{
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000172 if (m->m_self == NULL)
Barry Warsaw7ce36942001-08-24 18:34:26 +0000173 return PyString_FromFormat("<built-in function %s>",
174 m->m_ml->ml_name);
175 return PyString_FromFormat("<built-in method %s of %s object at %p>",
176 m->m_ml->ml_name,
177 m->m_self->ob_type->tp_name,
178 m->m_self);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000179}
180
Guido van Rossum9bfef441993-03-29 10:43:31 +0000181static int
Fred Drakeee238b92000-07-09 06:03:25 +0000182meth_compare(PyCFunctionObject *a, PyCFunctionObject *b)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000183{
184 if (a->m_self != b->m_self)
Guido van Rossum13fdf5e1998-12-04 18:52:55 +0000185 return (a->m_self < b->m_self) ? -1 : 1;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000186 if (a->m_ml->ml_meth == b->m_ml->ml_meth)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000187 return 0;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000188 if (strcmp(a->m_ml->ml_name, b->m_ml->ml_name) < 0)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000189 return -1;
190 else
191 return 1;
192}
193
194static long
Fred Drakeee238b92000-07-09 06:03:25 +0000195meth_hash(PyCFunctionObject *a)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000196{
Fred Drake13634cf2000-06-29 19:17:04 +0000197 long x,y;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000198 if (a->m_self == NULL)
199 x = 0;
200 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000201 x = PyObject_Hash(a->m_self);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000202 if (x == -1)
203 return -1;
204 }
Guido van Rossum9a15c212000-06-30 22:46:04 +0000205 y = _Py_HashPointer((void*)(a->m_ml->ml_meth));
Fred Drake13634cf2000-06-29 19:17:04 +0000206 if (y == -1)
207 return -1;
208 x ^= y;
209 if (x == -1)
210 x = -2;
211 return x;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000212}
213
Tim Peters6d6c1a32001-08-02 04:15:00 +0000214
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000215PyTypeObject PyCFunction_Type = {
216 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000217 0,
Guido van Rossum7066dd71992-09-17 17:54:56 +0000218 "builtin_function_or_method",
Neil Schemenauerd91eec92002-03-18 20:44:53 +0000219 sizeof(PyCFunctionObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000220 0,
Neil Schemenauer10c66922001-07-12 13:27:35 +0000221 (destructor)meth_dealloc, /* tp_dealloc */
222 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000223 0, /* tp_getattr */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000224 0, /* tp_setattr */
225 (cmpfunc)meth_compare, /* tp_compare */
226 (reprfunc)meth_repr, /* tp_repr */
227 0, /* tp_as_number */
228 0, /* tp_as_sequence */
229 0, /* tp_as_mapping */
230 (hashfunc)meth_hash, /* tp_hash */
Jeremy Hylton910d7d42001-08-12 21:52:24 +0000231 PyCFunction_Call, /* tp_call */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000232 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000233 PyObject_GenericGetAttr, /* tp_getattro */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000234 0, /* tp_setattro */
235 0, /* tp_as_buffer */
Neil Schemenauerd91eec92002-03-18 20:44:53 +0000236 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000237 0, /* tp_doc */
238 (traverseproc)meth_traverse, /* tp_traverse */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000239 0, /* tp_clear */
240 0, /* tp_richcompare */
241 0, /* tp_weaklistoffset */
242 0, /* tp_iter */
243 0, /* tp_iternext */
244 0, /* tp_methods */
245 0, /* tp_members */
246 meth_getsets, /* tp_getset */
247 0, /* tp_base */
248 0, /* tp_dict */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000249};
Guido van Rossum3f5da241990-12-20 15:06:42 +0000250
Guido van Rossum69785031995-01-26 22:58:48 +0000251/* List all methods in a chain -- helper for findmethodinchain */
Guido van Rossume9c430f1991-10-20 20:21:15 +0000252
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000253static PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000254listmethodchain(PyMethodChain *chain)
Guido van Rossume9c430f1991-10-20 20:21:15 +0000255{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000256 PyMethodChain *c;
257 PyMethodDef *ml;
Guido van Rossume9c430f1991-10-20 20:21:15 +0000258 int i, n;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000259 PyObject *v;
Guido van Rossum69785031995-01-26 22:58:48 +0000260
261 n = 0;
262 for (c = chain; c != NULL; c = c->link) {
263 for (ml = c->methods; ml->ml_name != NULL; ml++)
264 n++;
265 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000266 v = PyList_New(n);
Guido van Rossum69785031995-01-26 22:58:48 +0000267 if (v == NULL)
268 return NULL;
269 i = 0;
270 for (c = chain; c != NULL; c = c->link) {
271 for (ml = c->methods; ml->ml_name != NULL; ml++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000272 PyList_SetItem(v, i, PyString_FromString(ml->ml_name));
Guido van Rossum69785031995-01-26 22:58:48 +0000273 i++;
Guido van Rossume9c430f1991-10-20 20:21:15 +0000274 }
275 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000276 if (PyErr_Occurred()) {
277 Py_DECREF(v);
Guido van Rossum69785031995-01-26 22:58:48 +0000278 return NULL;
279 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000280 PyList_Sort(v);
Guido van Rossume9c430f1991-10-20 20:21:15 +0000281 return v;
282}
283
Guido van Rossum69785031995-01-26 22:58:48 +0000284/* Find a method in a method chain */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000285
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000286PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000287Py_FindMethodInChain(PyMethodChain *chain, PyObject *self, char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000288{
Guido van Rossum8a92c621998-06-27 18:28:59 +0000289 if (name[0] == '_' && name[1] == '_') {
290 if (strcmp(name, "__methods__") == 0)
291 return listmethodchain(chain);
292 if (strcmp(name, "__doc__") == 0) {
293 char *doc = self->ob_type->tp_doc;
294 if (doc != NULL)
295 return PyString_FromString(doc);
296 }
297 }
Guido van Rossum69785031995-01-26 22:58:48 +0000298 while (chain != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000299 PyMethodDef *ml = chain->methods;
Guido van Rossum69785031995-01-26 22:58:48 +0000300 for (; ml->ml_name != NULL; ml++) {
301 if (name[0] == ml->ml_name[0] &&
302 strcmp(name+1, ml->ml_name+1) == 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000303 return PyCFunction_New(ml, self);
Guido van Rossum69785031995-01-26 22:58:48 +0000304 }
305 chain = chain->link;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000306 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000307 PyErr_SetString(PyExc_AttributeError, name);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000308 return NULL;
309}
Guido van Rossum69785031995-01-26 22:58:48 +0000310
311/* Find a method in a single method list */
312
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000313PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000314Py_FindMethod(PyMethodDef *methods, PyObject *self, char *name)
Guido van Rossum69785031995-01-26 22:58:48 +0000315{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000316 PyMethodChain chain;
Guido van Rossum69785031995-01-26 22:58:48 +0000317 chain.methods = methods;
318 chain.link = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000319 return Py_FindMethodInChain(&chain, self, name);
Guido van Rossum69785031995-01-26 22:58:48 +0000320}
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000321
322/* Clear out the free list */
323
324void
Fred Drakeee238b92000-07-09 06:03:25 +0000325PyCFunction_Fini(void)
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000326{
327 while (free_list) {
328 PyCFunctionObject *v = free_list;
329 free_list = (PyCFunctionObject *)(v->m_self);
Neil Schemenauerd91eec92002-03-18 20:44:53 +0000330 PyObject_GC_Del(v);
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000331 }
332}