blob: 56fbcc22fd9a05b6046effc5caa10c14cd54e905 [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
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000059/* Methods (the standard built-in methods, that is) */
60
61static void
Fred Drakeee238b92000-07-09 06:03:25 +000062meth_dealloc(PyCFunctionObject *m)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000063{
Neil Schemenauer10c66922001-07-12 13:27:35 +000064 PyObject_GC_Fini(m);
Guido van Rossumc0b618a1997-05-02 03:12:38 +000065 Py_XDECREF(m->m_self);
Guido van Rossum1f39c5c1997-08-05 02:11:41 +000066 m->m_self = (PyObject *)free_list;
67 free_list = m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000068}
69
Tim Peters6d6c1a32001-08-02 04:15:00 +000070static PyObject *
71meth_get__doc__(PyCFunctionObject *m, void *closure)
72{
73 char *doc = m->m_ml->ml_doc;
74
75 if (doc != NULL)
76 return PyString_FromString(doc);
77 Py_INCREF(Py_None);
78 return Py_None;
79}
80
81static PyObject *
82meth_get__name__(PyCFunctionObject *m, void *closure)
83{
84 return PyString_FromString(m->m_ml->ml_name);
85}
86
Neil Schemenauer10c66922001-07-12 13:27:35 +000087static int
88meth_traverse(PyCFunctionObject *m, visitproc visit, void *arg)
89{
90 if (m->m_self != NULL)
91 return visit(m->m_self, arg);
92 else
93 return 0;
94}
95
Guido van Rossumc0b618a1997-05-02 03:12:38 +000096static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +000097meth_get__self__(PyCFunctionObject *m, void *closure)
Guido van Rossumcab650d1995-01-07 12:34:58 +000098{
Tim Peters6d6c1a32001-08-02 04:15:00 +000099 PyObject *self;
100 if (PyEval_GetRestricted()) {
101 PyErr_SetString(PyExc_RuntimeError,
102 "method.__self__ not accessible in restricted mode");
103 return NULL;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000104 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000105 self = m->m_self;
106 if (self == NULL)
107 self = Py_None;
108 Py_INCREF(self);
109 return self;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000110}
111
Tim Peters6d6c1a32001-08-02 04:15:00 +0000112static struct getsetlist meth_getsets [] = {
113 {"__doc__", (getter)meth_get__doc__, NULL, NULL},
114 {"__name__", (getter)meth_get__name__, NULL, NULL},
115 {"__self__", (getter)meth_get__self__, NULL, NULL},
116 {0}
117};
118
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000119static PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000120meth_repr(PyCFunctionObject *m)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000121{
122 char buf[200];
123 if (m->m_self == NULL)
Guido van Rossumcab650d1995-01-07 12:34:58 +0000124 sprintf(buf, "<built-in function %.80s>", m->m_ml->ml_name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000125 else
Guido van Rossum3f5da241990-12-20 15:06:42 +0000126 sprintf(buf,
Fred Drakea44d3532000-06-30 15:01:00 +0000127 "<built-in method %.80s of %.80s object at %p>",
Guido van Rossumcab650d1995-01-07 12:34:58 +0000128 m->m_ml->ml_name, m->m_self->ob_type->tp_name,
Fred Drakea44d3532000-06-30 15:01:00 +0000129 m->m_self);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000130 return PyString_FromString(buf);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000131}
132
Guido van Rossum9bfef441993-03-29 10:43:31 +0000133static int
Fred Drakeee238b92000-07-09 06:03:25 +0000134meth_compare(PyCFunctionObject *a, PyCFunctionObject *b)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000135{
136 if (a->m_self != b->m_self)
Guido van Rossum13fdf5e1998-12-04 18:52:55 +0000137 return (a->m_self < b->m_self) ? -1 : 1;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000138 if (a->m_ml->ml_meth == b->m_ml->ml_meth)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000139 return 0;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000140 if (strcmp(a->m_ml->ml_name, b->m_ml->ml_name) < 0)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000141 return -1;
142 else
143 return 1;
144}
145
146static long
Fred Drakeee238b92000-07-09 06:03:25 +0000147meth_hash(PyCFunctionObject *a)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000148{
Fred Drake13634cf2000-06-29 19:17:04 +0000149 long x,y;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000150 if (a->m_self == NULL)
151 x = 0;
152 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000153 x = PyObject_Hash(a->m_self);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000154 if (x == -1)
155 return -1;
156 }
Guido van Rossum9a15c212000-06-30 22:46:04 +0000157 y = _Py_HashPointer((void*)(a->m_ml->ml_meth));
Fred Drake13634cf2000-06-29 19:17:04 +0000158 if (y == -1)
159 return -1;
160 x ^= y;
161 if (x == -1)
162 x = -2;
163 return x;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000164}
165
Tim Peters6d6c1a32001-08-02 04:15:00 +0000166static PyObject *
167meth_call(PyObject *func, PyObject *arg, PyObject *kw)
168{
169 PyCFunctionObject* f = (PyCFunctionObject*)func;
170 PyCFunction meth = PyCFunction_GET_FUNCTION(func);
171 PyObject *self = PyCFunction_GET_SELF(func);
172 int flags = PyCFunction_GET_FLAGS(func);
173
174 if (flags & METH_KEYWORDS) {
175 return (*(PyCFunctionWithKeywords)meth)(self, arg, kw);
176 }
177 if (kw != NULL && PyDict_Size(kw) != 0) {
178 PyErr_Format(PyExc_TypeError,
179 "%.200s() takes no keyword arguments",
180 f->m_ml->ml_name);
181 return NULL;
182 }
183 if (flags & METH_VARARGS) {
184 return (*meth)(self, arg);
185 }
186 if (!(flags & METH_VARARGS)) {
187 /* the really old style */
188 int size = PyTuple_GET_SIZE(arg);
189 if (size == 1)
190 arg = PyTuple_GET_ITEM(arg, 0);
191 else if (size == 0)
192 arg = NULL;
193 return (*meth)(self, arg);
194 }
195 /* should never get here ??? */
196 PyErr_BadInternalCall();
197 return NULL;
198}
199
200
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000201PyTypeObject PyCFunction_Type = {
202 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000203 0,
Guido van Rossum7066dd71992-09-17 17:54:56 +0000204 "builtin_function_or_method",
Neil Schemenauer10c66922001-07-12 13:27:35 +0000205 sizeof(PyCFunctionObject) + PyGC_HEAD_SIZE,
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000206 0,
Neil Schemenauer10c66922001-07-12 13:27:35 +0000207 (destructor)meth_dealloc, /* tp_dealloc */
208 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000209 0, /* tp_getattr */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000210 0, /* tp_setattr */
211 (cmpfunc)meth_compare, /* tp_compare */
212 (reprfunc)meth_repr, /* tp_repr */
213 0, /* tp_as_number */
214 0, /* tp_as_sequence */
215 0, /* tp_as_mapping */
216 (hashfunc)meth_hash, /* tp_hash */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000217 meth_call, /* tp_call */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000218 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000219 PyObject_GenericGetAttr, /* tp_getattro */
Neil Schemenauer10c66922001-07-12 13:27:35 +0000220 0, /* tp_setattro */
221 0, /* tp_as_buffer */
222 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_GC, /* tp_flags */
223 0, /* tp_doc */
224 (traverseproc)meth_traverse, /* tp_traverse */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000225 0, /* tp_clear */
226 0, /* tp_richcompare */
227 0, /* tp_weaklistoffset */
228 0, /* tp_iter */
229 0, /* tp_iternext */
230 0, /* tp_methods */
231 0, /* tp_members */
232 meth_getsets, /* tp_getset */
233 0, /* tp_base */
234 0, /* tp_dict */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000235};
Guido van Rossum3f5da241990-12-20 15:06:42 +0000236
Guido van Rossum69785031995-01-26 22:58:48 +0000237/* List all methods in a chain -- helper for findmethodinchain */
Guido van Rossume9c430f1991-10-20 20:21:15 +0000238
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000239static PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000240listmethodchain(PyMethodChain *chain)
Guido van Rossume9c430f1991-10-20 20:21:15 +0000241{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000242 PyMethodChain *c;
243 PyMethodDef *ml;
Guido van Rossume9c430f1991-10-20 20:21:15 +0000244 int i, n;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000245 PyObject *v;
Guido van Rossum69785031995-01-26 22:58:48 +0000246
247 n = 0;
248 for (c = chain; c != NULL; c = c->link) {
249 for (ml = c->methods; ml->ml_name != NULL; ml++)
250 n++;
251 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000252 v = PyList_New(n);
Guido van Rossum69785031995-01-26 22:58:48 +0000253 if (v == NULL)
254 return NULL;
255 i = 0;
256 for (c = chain; c != NULL; c = c->link) {
257 for (ml = c->methods; ml->ml_name != NULL; ml++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000258 PyList_SetItem(v, i, PyString_FromString(ml->ml_name));
Guido van Rossum69785031995-01-26 22:58:48 +0000259 i++;
Guido van Rossume9c430f1991-10-20 20:21:15 +0000260 }
261 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000262 if (PyErr_Occurred()) {
263 Py_DECREF(v);
Guido van Rossum69785031995-01-26 22:58:48 +0000264 return NULL;
265 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000266 PyList_Sort(v);
Guido van Rossume9c430f1991-10-20 20:21:15 +0000267 return v;
268}
269
Guido van Rossum69785031995-01-26 22:58:48 +0000270/* Find a method in a method chain */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000271
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000272PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000273Py_FindMethodInChain(PyMethodChain *chain, PyObject *self, char *name)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000274{
Guido van Rossum8a92c621998-06-27 18:28:59 +0000275 if (name[0] == '_' && name[1] == '_') {
276 if (strcmp(name, "__methods__") == 0)
277 return listmethodchain(chain);
278 if (strcmp(name, "__doc__") == 0) {
279 char *doc = self->ob_type->tp_doc;
280 if (doc != NULL)
281 return PyString_FromString(doc);
282 }
283 }
Guido van Rossum69785031995-01-26 22:58:48 +0000284 while (chain != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000285 PyMethodDef *ml = chain->methods;
Guido van Rossum69785031995-01-26 22:58:48 +0000286 for (; ml->ml_name != NULL; ml++) {
287 if (name[0] == ml->ml_name[0] &&
288 strcmp(name+1, ml->ml_name+1) == 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000289 return PyCFunction_New(ml, self);
Guido van Rossum69785031995-01-26 22:58:48 +0000290 }
291 chain = chain->link;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000292 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000293 PyErr_SetString(PyExc_AttributeError, name);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000294 return NULL;
295}
Guido van Rossum69785031995-01-26 22:58:48 +0000296
297/* Find a method in a single method list */
298
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000299PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000300Py_FindMethod(PyMethodDef *methods, PyObject *self, char *name)
Guido van Rossum69785031995-01-26 22:58:48 +0000301{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000302 PyMethodChain chain;
Guido van Rossum69785031995-01-26 22:58:48 +0000303 chain.methods = methods;
304 chain.link = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000305 return Py_FindMethodInChain(&chain, self, name);
Guido van Rossum69785031995-01-26 22:58:48 +0000306}
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000307
308/* Clear out the free list */
309
310void
Fred Drakeee238b92000-07-09 06:03:25 +0000311PyCFunction_Fini(void)
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000312{
313 while (free_list) {
314 PyCFunctionObject *v = free_list;
315 free_list = (PyCFunctionObject *)(v->m_self);
Neil Schemenauer10c66922001-07-12 13:27:35 +0000316 v = (PyCFunctionObject *) PyObject_AS_GC(v);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000317 PyObject_DEL(v);
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000318 }
319}