blob: f6ec71ee73c09614efac6bcc1857089b5901539b [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
7Permission to use, copy, modify, and distribute this software and its
8documentation for any purpose and without fee is hereby granted,
9provided that the above copyright notice appear in all copies and that
10both that copyright notice and this permission notice appear in
11supporting documentation, and that the names of Stichting Mathematisch
12Centrum or CWI not be used in advertising or publicity pertaining to
13distribution of the software without specific, written prior permission.
14
15STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
16THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
17FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
18FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
19WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
20ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
21OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22
23******************************************************************/
24
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000025/* Function object implementation */
26
Guido van Rossum3f5da241990-12-20 15:06:42 +000027#include "allobjects.h"
Guido van Rossum9bfef441993-03-29 10:43:31 +000028#include "compile.h"
Guido van Rossum3f5da241990-12-20 15:06:42 +000029#include "structmember.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000030
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031object *
Guido van Rossum846e4311990-11-18 17:44:06 +000032newfuncobject(code, globals)
33 object *code;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000034 object *globals;
35{
36 funcobject *op = NEWOBJ(funcobject, &Functype);
37 if (op != NULL) {
Guido van Rossum5bd38051995-01-07 12:01:30 +000038 object *doc;
39 object *consts;
Guido van Rossum846e4311990-11-18 17:44:06 +000040 INCREF(code);
41 op->func_code = code;
42 INCREF(globals);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000043 op->func_globals = globals;
Guido van Rossum5bd38051995-01-07 12:01:30 +000044 op->func_name = ((codeobject *)code)->co_name;
Guido van Rossum25831651993-05-19 14:50:45 +000045 INCREF(op->func_name);
Guido van Rossum2271bf71995-07-18 14:30:34 +000046 op->func_defaults = NULL; /* No default arguments */
Guido van Rossum5bd38051995-01-07 12:01:30 +000047 consts = ((codeobject *)code)->co_consts;
48 if (gettuplesize(consts) >= 1) {
49 doc = gettupleitem(consts, 0);
50 if (!is_stringobject(doc))
51 doc = None;
52 }
53 else
54 doc = None;
55 INCREF(doc);
56 op->func_doc = doc;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000057 }
58 return (object *)op;
59}
60
Guido van Rossum846e4311990-11-18 17:44:06 +000061object *
62getfunccode(op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000063 object *op;
64{
65 if (!is_funcobject(op)) {
Guido van Rossum2a9096b1990-10-21 22:15:08 +000066 err_badcall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000067 return NULL;
68 }
Guido van Rossum846e4311990-11-18 17:44:06 +000069 return ((funcobject *) op) -> func_code;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000070}
71
72object *
73getfuncglobals(op)
74 object *op;
75{
76 if (!is_funcobject(op)) {
Guido van Rossum2a9096b1990-10-21 22:15:08 +000077 err_badcall();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000078 return NULL;
79 }
80 return ((funcobject *) op) -> func_globals;
81}
82
Guido van Rossum1d5735e1994-08-30 08:27:36 +000083object *
Guido van Rossum2271bf71995-07-18 14:30:34 +000084PyFunction_GetDefaults(op)
Guido van Rossum1d5735e1994-08-30 08:27:36 +000085 object *op;
Guido van Rossum1d5735e1994-08-30 08:27:36 +000086{
87 if (!is_funcobject(op)) {
88 err_badcall();
89 return NULL;
90 }
Guido van Rossum2271bf71995-07-18 14:30:34 +000091 return ((funcobject *) op) -> func_defaults;
Guido van Rossum1d5735e1994-08-30 08:27:36 +000092}
93
94int
Guido van Rossum2271bf71995-07-18 14:30:34 +000095PyFunction_SetDefaults(op, defaults)
Guido van Rossum1d5735e1994-08-30 08:27:36 +000096 object *op;
Guido van Rossum2271bf71995-07-18 14:30:34 +000097 object *defaults;
Guido van Rossum1d5735e1994-08-30 08:27:36 +000098{
Guido van Rossum2271bf71995-07-18 14:30:34 +000099 if (!is_funcobject(op)) {
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000100 err_badcall();
101 return -1;
102 }
Guido van Rossum2271bf71995-07-18 14:30:34 +0000103 if (defaults == None)
104 defaults = NULL;
105 else if (is_tupleobject(defaults))
106 XINCREF(defaults);
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000107 else {
108 err_setstr(SystemError, "non-tuple default args");
109 return -1;
110 }
Guido van Rossum2271bf71995-07-18 14:30:34 +0000111 XDECREF(((funcobject *) op) -> func_defaults);
112 ((funcobject *) op) -> func_defaults = defaults;
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000113 return 0;
114}
115
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000116/* Methods */
117
Guido van Rossum3f5da241990-12-20 15:06:42 +0000118#define OFF(x) offsetof(funcobject, x)
119
120static struct memberlist func_memberlist[] = {
Guido van Rossuma38c0ff1992-01-14 18:32:20 +0000121 {"func_code", T_OBJECT, OFF(func_code), READONLY},
122 {"func_globals",T_OBJECT, OFF(func_globals), READONLY},
Guido van Rossum25831651993-05-19 14:50:45 +0000123 {"func_name", T_OBJECT, OFF(func_name), READONLY},
Guido van Rossum10393b11995-01-10 10:39:49 +0000124 {"__name__", T_OBJECT, OFF(func_name), READONLY},
Guido van Rossum2271bf71995-07-18 14:30:34 +0000125 {"func_defaults",T_OBJECT, OFF(func_defaults), READONLY},
Guido van Rossum5bd38051995-01-07 12:01:30 +0000126 {"func_doc", T_OBJECT, OFF(func_doc)},
127 {"__doc__", T_OBJECT, OFF(func_doc)},
Guido van Rossum3f5da241990-12-20 15:06:42 +0000128 {NULL} /* Sentinel */
129};
130
131static object *
132func_getattr(op, name)
133 funcobject *op;
134 char *name;
135{
Guido van Rossum10393b11995-01-10 10:39:49 +0000136 if (name[0] != '_' && getrestricted()) {
137 err_setstr(RuntimeError,
138 "function attributes not accessible in restricted mode");
139 return NULL;
140 }
Guido van Rossum3f5da241990-12-20 15:06:42 +0000141 return getmember((char *)op, func_memberlist, name);
142}
143
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000144static void
Guido van Rossum3f5da241990-12-20 15:06:42 +0000145func_dealloc(op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000146 funcobject *op;
147{
Guido van Rossum846e4311990-11-18 17:44:06 +0000148 DECREF(op->func_code);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000149 DECREF(op->func_globals);
Guido van Rossume9c6bcd1995-01-20 16:58:19 +0000150 DECREF(op->func_name);
Guido van Rossum2271bf71995-07-18 14:30:34 +0000151 XDECREF(op->func_defaults);
Guido van Rossum5bd38051995-01-07 12:01:30 +0000152 XDECREF(op->func_doc);
Guido van Rossum846e4311990-11-18 17:44:06 +0000153 DEL(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000154}
155
Guido van Rossum9bfef441993-03-29 10:43:31 +0000156static object*
157func_repr(op)
158 funcobject *op;
159{
160 char buf[140];
Guido van Rossum590baa41993-11-30 13:40:46 +0000161 if (op->func_name == None)
162 sprintf(buf, "<anonymous function at %lx>", (long)op);
163 else
164 sprintf(buf, "<function %.100s at %lx>",
165 getstringvalue(op->func_name),
166 (long)op);
Guido van Rossum9bfef441993-03-29 10:43:31 +0000167 return newstringobject(buf);
168}
169
Guido van Rossum2e8f8a31993-11-05 10:20:10 +0000170static int
171func_compare(f, g)
172 funcobject *f, *g;
173{
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000174 int c;
Guido van Rossum2e8f8a31993-11-05 10:20:10 +0000175 if (f->func_globals != g->func_globals)
176 return (f->func_globals < g->func_globals) ? -1 : 1;
Guido van Rossum2271bf71995-07-18 14:30:34 +0000177 c = cmpobject(f->func_defaults, g->func_defaults);
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000178 if (c != 0)
179 return c;
Guido van Rossum2e8f8a31993-11-05 10:20:10 +0000180 return cmpobject(f->func_code, g->func_code);
181}
182
183static long
184func_hash(f)
185 funcobject *f;
186{
187 long h;
188 h = hashobject(f->func_code);
189 if (h == -1) return h;
190 h = h ^ (long)f->func_globals;
191 if (h == -1) h = -2;
192 return h;
193}
194
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000195typeobject Functype = {
196 OB_HEAD_INIT(&Typetype)
197 0,
198 "function",
199 sizeof(funcobject),
200 0,
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000201 (destructor)func_dealloc, /*tp_dealloc*/
Guido van Rossum846e4311990-11-18 17:44:06 +0000202 0, /*tp_print*/
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000203 (getattrfunc)func_getattr, /*tp_getattr*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000204 0, /*tp_setattr*/
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000205 (cmpfunc)func_compare, /*tp_compare*/
206 (reprfunc)func_repr, /*tp_repr*/
Guido van Rossum2e8f8a31993-11-05 10:20:10 +0000207 0, /*tp_as_number*/
208 0, /*tp_as_sequence*/
209 0, /*tp_as_mapping*/
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000210 (hashfunc)func_hash, /*tp_hash*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000211};