blob: c21d22c809590c8fa0bc63d7b8d18ec48e26bdbf [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001/***********************************************************
Guido van Rossum6610ad91995-01-04 19:07:38 +00002Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
3The Netherlands.
Guido van Rossumf70e43a1991-02-19 12:39:46 +00004
5 All Rights Reserved
6
Guido van Rossumfd71b9e2000-06-30 23:50:40 +00007Copyright (c) 2000, BeOpen.com.
8Copyright (c) 1995-2000, Corporation for National Research Initiatives.
9Copyright (c) 1990-1995, Stichting Mathematisch Centrum.
10All rights reserved.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000011
Guido van Rossumfd71b9e2000-06-30 23:50:40 +000012See the file "Misc/COPYRIGHT" for information on usage and
13redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000014
15******************************************************************/
16
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000017/* Method object implementation */
18
Guido van Rossumc0b618a1997-05-02 03:12:38 +000019#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000020
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000021#include "token.h"
22
Guido van Rossum1f39c5c1997-08-05 02:11:41 +000023static PyCFunctionObject *free_list = NULL;
24
Guido van Rossumc0b618a1997-05-02 03:12:38 +000025PyObject *
26PyCFunction_New(ml, self)
27 PyMethodDef *ml;
28 PyObject *self;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000029{
Guido van Rossum1f39c5c1997-08-05 02:11:41 +000030 PyCFunctionObject *op;
31 op = free_list;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000032 if (op != NULL) {
Guido van Rossum1f39c5c1997-08-05 02:11:41 +000033 free_list = (PyCFunctionObject *)(op->m_self);
Guido van Rossumb18618d2000-05-03 23:44:39 +000034 PyObject_INIT(op, &PyCFunction_Type);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000035 }
Guido van Rossum1f39c5c1997-08-05 02:11:41 +000036 else {
37 op = PyObject_NEW(PyCFunctionObject, &PyCFunction_Type);
38 if (op == NULL)
39 return NULL;
40 }
41 op->m_ml = ml;
42 Py_XINCREF(self);
43 op->m_self = self;
Guido van Rossumc0b618a1997-05-02 03:12:38 +000044 return (PyObject *)op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000045}
46
Guido van Rossumc0b618a1997-05-02 03:12:38 +000047PyCFunction
48PyCFunction_GetFunction(op)
49 PyObject *op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000050{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000051 if (!PyCFunction_Check(op)) {
52 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000053 return NULL;
54 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +000055 return ((PyCFunctionObject *)op) -> m_ml -> ml_meth;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000056}
57
Guido van Rossumc0b618a1997-05-02 03:12:38 +000058PyObject *
59PyCFunction_GetSelf(op)
60 PyObject *op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000061{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000062 if (!PyCFunction_Check(op)) {
63 PyErr_BadInternalCall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000064 return NULL;
65 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +000066 return ((PyCFunctionObject *)op) -> m_self;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000067}
68
Guido van Rossumc0602291991-12-16 13:07:24 +000069int
Guido van Rossumc0b618a1997-05-02 03:12:38 +000070PyCFunction_GetFlags(op)
71 PyObject *op;
Guido van Rossumc0602291991-12-16 13:07:24 +000072{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000073 if (!PyCFunction_Check(op)) {
74 PyErr_BadInternalCall();
Guido van Rossumc0602291991-12-16 13:07:24 +000075 return -1;
76 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +000077 return ((PyCFunctionObject *)op) -> m_ml -> ml_flags;
Guido van Rossumc0602291991-12-16 13:07:24 +000078}
79
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000080/* Methods (the standard built-in methods, that is) */
81
82static void
83meth_dealloc(m)
Guido van Rossumc0b618a1997-05-02 03:12:38 +000084 PyCFunctionObject *m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000085{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000086 Py_XDECREF(m->m_self);
Guido van Rossum1f39c5c1997-08-05 02:11:41 +000087 m->m_self = (PyObject *)free_list;
88 free_list = m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000089}
90
Guido van Rossumc0b618a1997-05-02 03:12:38 +000091static PyObject *
Guido van Rossumcab650d1995-01-07 12:34:58 +000092meth_getattr(m, name)
Guido van Rossumc0b618a1997-05-02 03:12:38 +000093 PyCFunctionObject *m;
Guido van Rossumcab650d1995-01-07 12:34:58 +000094 char *name;
95{
96 if (strcmp(name, "__name__") == 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +000097 return PyString_FromString(m->m_ml->ml_name);
Guido van Rossumcab650d1995-01-07 12:34:58 +000098 }
99 if (strcmp(name, "__doc__") == 0) {
100 char *doc = m->m_ml->ml_doc;
101 if (doc != NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000102 return PyString_FromString(doc);
103 Py_INCREF(Py_None);
104 return Py_None;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000105 }
106 if (strcmp(name, "__self__") == 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000107 PyObject *self;
108 if (PyEval_GetRestricted()) {
109 PyErr_SetString(PyExc_RuntimeError,
Guido van Rossum10393b11995-01-10 10:39:49 +0000110 "method.__self__ not accessible in restricted mode");
111 return NULL;
112 }
113 self = m->m_self;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000114 if (self == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000115 self = Py_None;
116 Py_INCREF(self);
Guido van Rossumcab650d1995-01-07 12:34:58 +0000117 return self;
118 }
119 if (strcmp(name, "__members__") == 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000120 return Py_BuildValue("[sss]",
121 "__doc__", "__name__", "__self__");
Guido van Rossumcab650d1995-01-07 12:34:58 +0000122 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000123 PyErr_SetString(PyExc_AttributeError, name);
Guido van Rossumcab650d1995-01-07 12:34:58 +0000124 return NULL;
125}
126
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000127static PyObject *
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000128meth_repr(m)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000129 PyCFunctionObject *m;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000130{
131 char buf[200];
132 if (m->m_self == NULL)
Guido van Rossumcab650d1995-01-07 12:34:58 +0000133 sprintf(buf, "<built-in function %.80s>", m->m_ml->ml_name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000134 else
Guido van Rossum3f5da241990-12-20 15:06:42 +0000135 sprintf(buf,
Fred Drakea44d3532000-06-30 15:01:00 +0000136 "<built-in method %.80s of %.80s object at %p>",
Guido van Rossumcab650d1995-01-07 12:34:58 +0000137 m->m_ml->ml_name, m->m_self->ob_type->tp_name,
Fred Drakea44d3532000-06-30 15:01:00 +0000138 m->m_self);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000139 return PyString_FromString(buf);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000140}
141
Guido van Rossum9bfef441993-03-29 10:43:31 +0000142static int
143meth_compare(a, b)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000144 PyCFunctionObject *a, *b;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000145{
146 if (a->m_self != b->m_self)
Guido van Rossum13fdf5e1998-12-04 18:52:55 +0000147 return (a->m_self < b->m_self) ? -1 : 1;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000148 if (a->m_ml->ml_meth == b->m_ml->ml_meth)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000149 return 0;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000150 if (strcmp(a->m_ml->ml_name, b->m_ml->ml_name) < 0)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000151 return -1;
152 else
153 return 1;
154}
155
156static long
157meth_hash(a)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000158 PyCFunctionObject *a;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000159{
Fred Drake13634cf2000-06-29 19:17:04 +0000160 long x,y;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000161 if (a->m_self == NULL)
162 x = 0;
163 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000164 x = PyObject_Hash(a->m_self);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000165 if (x == -1)
166 return -1;
167 }
Guido van Rossum9a15c212000-06-30 22:46:04 +0000168 y = _Py_HashPointer((void*)(a->m_ml->ml_meth));
Fred Drake13634cf2000-06-29 19:17:04 +0000169 if (y == -1)
170 return -1;
171 x ^= y;
172 if (x == -1)
173 x = -2;
174 return x;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000175}
176
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000177PyTypeObject PyCFunction_Type = {
178 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000179 0,
Guido van Rossum7066dd71992-09-17 17:54:56 +0000180 "builtin_function_or_method",
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000181 sizeof(PyCFunctionObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000182 0,
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000183 (destructor)meth_dealloc, /*tp_dealloc*/
Guido van Rossum7066dd71992-09-17 17:54:56 +0000184 0, /*tp_print*/
Guido van Rossumcab650d1995-01-07 12:34:58 +0000185 (getattrfunc)meth_getattr, /*tp_getattr*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000186 0, /*tp_setattr*/
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000187 (cmpfunc)meth_compare, /*tp_compare*/
188 (reprfunc)meth_repr, /*tp_repr*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000189 0, /*tp_as_number*/
190 0, /*tp_as_sequence*/
191 0, /*tp_as_mapping*/
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000192 (hashfunc)meth_hash, /*tp_hash*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000193};
Guido van Rossum3f5da241990-12-20 15:06:42 +0000194
Guido van Rossum69785031995-01-26 22:58:48 +0000195/* List all methods in a chain -- helper for findmethodinchain */
Guido van Rossume9c430f1991-10-20 20:21:15 +0000196
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000197static PyObject *
Guido van Rossum69785031995-01-26 22:58:48 +0000198listmethodchain(chain)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000199 PyMethodChain *chain;
Guido van Rossume9c430f1991-10-20 20:21:15 +0000200{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000201 PyMethodChain *c;
202 PyMethodDef *ml;
Guido van Rossume9c430f1991-10-20 20:21:15 +0000203 int i, n;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000204 PyObject *v;
Guido van Rossum69785031995-01-26 22:58:48 +0000205
206 n = 0;
207 for (c = chain; c != NULL; c = c->link) {
208 for (ml = c->methods; ml->ml_name != NULL; ml++)
209 n++;
210 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000211 v = PyList_New(n);
Guido van Rossum69785031995-01-26 22:58:48 +0000212 if (v == NULL)
213 return NULL;
214 i = 0;
215 for (c = chain; c != NULL; c = c->link) {
216 for (ml = c->methods; ml->ml_name != NULL; ml++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000217 PyList_SetItem(v, i, PyString_FromString(ml->ml_name));
Guido van Rossum69785031995-01-26 22:58:48 +0000218 i++;
Guido van Rossume9c430f1991-10-20 20:21:15 +0000219 }
220 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000221 if (PyErr_Occurred()) {
222 Py_DECREF(v);
Guido van Rossum69785031995-01-26 22:58:48 +0000223 return NULL;
224 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000225 PyList_Sort(v);
Guido van Rossume9c430f1991-10-20 20:21:15 +0000226 return v;
227}
228
Guido van Rossum69785031995-01-26 22:58:48 +0000229/* Find a method in a method chain */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000230
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000231PyObject *
232Py_FindMethodInChain(chain, self, name)
233 PyMethodChain *chain;
234 PyObject *self;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000235 char *name;
236{
Guido van Rossum8a92c621998-06-27 18:28:59 +0000237 if (name[0] == '_' && name[1] == '_') {
238 if (strcmp(name, "__methods__") == 0)
239 return listmethodchain(chain);
240 if (strcmp(name, "__doc__") == 0) {
241 char *doc = self->ob_type->tp_doc;
242 if (doc != NULL)
243 return PyString_FromString(doc);
244 }
245 }
Guido van Rossum69785031995-01-26 22:58:48 +0000246 while (chain != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000247 PyMethodDef *ml = chain->methods;
Guido van Rossum69785031995-01-26 22:58:48 +0000248 for (; ml->ml_name != NULL; ml++) {
249 if (name[0] == ml->ml_name[0] &&
250 strcmp(name+1, ml->ml_name+1) == 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000251 return PyCFunction_New(ml, self);
Guido van Rossum69785031995-01-26 22:58:48 +0000252 }
253 chain = chain->link;
Guido van Rossum3f5da241990-12-20 15:06:42 +0000254 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000255 PyErr_SetString(PyExc_AttributeError, name);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000256 return NULL;
257}
Guido van Rossum69785031995-01-26 22:58:48 +0000258
259/* Find a method in a single method list */
260
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000261PyObject *
262Py_FindMethod(methods, self, name)
263 PyMethodDef *methods;
264 PyObject *self;
Guido van Rossum69785031995-01-26 22:58:48 +0000265 char *name;
266{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000267 PyMethodChain chain;
Guido van Rossum69785031995-01-26 22:58:48 +0000268 chain.methods = methods;
269 chain.link = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000270 return Py_FindMethodInChain(&chain, self, name);
Guido van Rossum69785031995-01-26 22:58:48 +0000271}
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000272
273/* Clear out the free list */
274
275void
276PyCFunction_Fini()
277{
278 while (free_list) {
279 PyCFunctionObject *v = free_list;
280 free_list = (PyCFunctionObject *)(v->m_self);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000281 PyObject_DEL(v);
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000282 }
283}