* eval.c (RETURN): Wrap in do{}while(0) in order to make it
[bpt/guile.git] / libguile / gsubr.c
CommitLineData
dee01b01 1/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001 Free Software Foundation, Inc.
0f2d19dd
JB
2 *
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
6 * any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
82892bed
JB
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
0f2d19dd
JB
17 *
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
20 *
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
26 *
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
29 *
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
37 *
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
82892bed 40 * If you do not wish that, delete this exception notice. */
1bbd0b84 41
0f2d19dd
JB
42\f
43
44#include <stdio.h>
a0599745
MD
45#include "libguile/_scm.h"
46#include "libguile/procprop.h"
47#include "libguile/root.h"
0f2d19dd 48
a0599745 49#include "libguile/gsubr.h"
1be6b49c 50#include "libguile/deprecation.h"
0f2d19dd
JB
51\f
52/*
53 * gsubr.c
54 * Provide `gsubrs' -- subrs taking a prescribed number of required, optional,
55 * and rest arguments.
56 */
57
952bedad 58/* #define GSUBR_TEST */
0f2d19dd 59
85db4a2c
DH
60SCM_GLOBAL_SYMBOL (scm_sym_name, "name");
61
dc0938d8 62SCM scm_f_gsubr_apply;
1cc91f1b 63
9d78586f
MV
64static SCM
65create_gsubr (int define, const char *name,
66 int req, int opt, int rst, SCM (*fcn)())
0f2d19dd 67{
9d78586f
MV
68 SCM subr;
69
70 switch (SCM_GSUBR_MAKTYPE (req, opt, rst))
0f2d19dd 71 {
9d78586f
MV
72 case SCM_GSUBR_MAKTYPE(0, 0, 0):
73 subr = scm_c_make_subr (name, scm_tc7_subr_0, fcn);
74 goto create_subr;
75 case SCM_GSUBR_MAKTYPE(1, 0, 0):
76 subr = scm_c_make_subr (name, scm_tc7_subr_1, fcn);
77 goto create_subr;
78 case SCM_GSUBR_MAKTYPE(0, 1, 0):
79 subr = scm_c_make_subr (name, scm_tc7_subr_1o, fcn);
80 goto create_subr;
81 case SCM_GSUBR_MAKTYPE(1, 1, 0):
82 subr = scm_c_make_subr (name, scm_tc7_subr_2o, fcn);
83 goto create_subr;
84 case SCM_GSUBR_MAKTYPE(2, 0, 0):
85 subr = scm_c_make_subr (name, scm_tc7_subr_2, fcn);
86 goto create_subr;
87 case SCM_GSUBR_MAKTYPE(3, 0, 0):
88 subr = scm_c_make_subr (name, scm_tc7_subr_3, fcn);
89 goto create_subr;
90 case SCM_GSUBR_MAKTYPE(0, 0, 1):
91 subr = scm_c_make_subr (name, scm_tc7_lsubr, fcn);
92 goto create_subr;
93 case SCM_GSUBR_MAKTYPE(2, 0, 1):
94 subr = scm_c_make_subr (name, scm_tc7_lsubr_2, fcn);
95 create_subr:
96 if (define)
97 scm_define (SCM_SUBR_ENTRY(subr).name, subr);
98 return subr;
99 default:
100 {
101 SCM cclo = scm_makcclo (scm_f_gsubr_apply, 3L);
102 SCM subr = scm_c_make_subr (name, scm_tc7_subr_0, fcn);
103 SCM sym = SCM_SUBR_ENTRY(subr).name;
104 if (SCM_GSUBR_MAX < req + opt + rst)
105 {
106 fputs ("ERROR in scm_c_make_gsubr: too many args\n", stderr);
107 exit (1);
108 }
109 SCM_SET_GSUBR_PROC (cclo, subr);
110 SCM_SET_GSUBR_TYPE (cclo,
111 SCM_MAKINUM (SCM_GSUBR_MAKTYPE (req, opt, rst)));
abae3119 112#ifdef DEBUG_EXTENSIONS
9d78586f
MV
113 if (SCM_REC_PROCNAMES_P)
114 scm_set_procedure_property_x (cclo, scm_sym_name, sym);
abae3119 115#endif
9d78586f
MV
116 if (define)
117 scm_define (sym, cclo);
0f2d19dd 118 return cclo;
9d78586f 119 }
0f2d19dd 120 }
0f2d19dd
JB
121}
122
9de33deb 123SCM
9d78586f 124scm_c_make_gsubr (const char *name, int req, int opt, int rst, SCM (*fcn)())
9de33deb 125{
9d78586f
MV
126 return create_gsubr (0, name, req, opt, rst, fcn);
127}
128
129SCM
130scm_c_define_gsubr (const char *name, int req, int opt, int rst, SCM (*fcn)())
131{
132 return create_gsubr (1, name, req, opt, rst, fcn);
133}
134
135static SCM
136create_gsubr_with_generic (int define,
137 const char *name,
138 int req,
139 int opt,
140 int rst,
141 SCM (*fcn)(),
142 SCM *gf)
143{
144 SCM subr;
145
146 switch (SCM_GSUBR_MAKTYPE(req, opt, rst))
147 {
148 case SCM_GSUBR_MAKTYPE(0, 0, 0):
149 subr = scm_c_make_subr_with_generic (name, scm_tc7_subr_0, fcn, gf);
150 goto create_subr;
151 case SCM_GSUBR_MAKTYPE(1, 0, 0):
152 subr = scm_c_make_subr_with_generic (name, scm_tc7_subr_1, fcn, gf);
153 goto create_subr;
154 case SCM_GSUBR_MAKTYPE(0, 1, 0):
155 subr = scm_c_make_subr_with_generic (name, scm_tc7_subr_1o, fcn, gf);
156 goto create_subr;
157 case SCM_GSUBR_MAKTYPE(1, 1, 0):
158 subr = scm_c_make_subr_with_generic (name, scm_tc7_subr_2o, fcn, gf);
159 goto create_subr;
160 case SCM_GSUBR_MAKTYPE(2, 0, 0):
161 subr = scm_c_make_subr_with_generic (name, scm_tc7_subr_2, fcn, gf);
162 goto create_subr;
163 case SCM_GSUBR_MAKTYPE(3, 0, 0):
164 subr = scm_c_make_subr_with_generic (name, scm_tc7_subr_3, fcn, gf);
165 goto create_subr;
166 case SCM_GSUBR_MAKTYPE(0, 0, 1):
167 subr = scm_c_make_subr_with_generic (name, scm_tc7_lsubr, fcn, gf);
168 goto create_subr;
169 case SCM_GSUBR_MAKTYPE(2, 0, 1):
170 subr = scm_c_make_subr_with_generic (name, scm_tc7_lsubr_2, fcn, gf);
171 create_subr:
172 if (define)
173 scm_define (SCM_SUBR_ENTRY(subr).name, subr);
174 return subr;
175 default:
176 ;
177 }
178 scm_misc_error ("scm_c_make_gsubr_with_generic",
9de33deb
MD
179 "can't make primitive-generic with this arity",
180 SCM_EOL);
4260a7fc 181 return SCM_BOOL_F; /* never reached */
9de33deb
MD
182}
183
9d78586f
MV
184SCM
185scm_c_make_gsubr_with_generic (const char *name,
186 int req,
187 int opt,
188 int rst,
189 SCM (*fcn)(),
190 SCM *gf)
191{
192 return create_gsubr_with_generic (0, name, req, opt, rst, fcn, gf);
193}
194
195SCM
196scm_c_define_gsubr_with_generic (const char *name,
197 int req,
198 int opt,
199 int rst,
200 SCM (*fcn)(),
201 SCM *gf)
202{
203 return create_gsubr_with_generic (1, name, req, opt, rst, fcn, gf);
204}
205
0f2d19dd 206
6fa73e72
GB
207SCM
208scm_gsubr_apply (SCM args)
a4bb4e6d 209#define FUNC_NAME "scm_gsubr_apply"
0f2d19dd 210{
1be6b49c
ML
211 SCM self = SCM_CAR (args);
212 SCM (*fcn)() = SCM_SUBRF (SCM_GSUBR_PROC (self));
a4bb4e6d 213 SCM v[SCM_GSUBR_MAX];
c014a02e
ML
214 long typ = SCM_INUM (SCM_GSUBR_TYPE (self));
215 long i, n = SCM_GSUBR_REQ (typ) + SCM_GSUBR_OPT (typ) + SCM_GSUBR_REST (typ);
adc02cce 216#if 0
a4bb4e6d
DH
217 if (n > SCM_GSUBR_MAX)
218 scm_misc_error (FUNC_NAME,
219 "Function ~S has illegal arity ~S.",
1afff620 220 scm_list_2 (self, SCM_MAKINUM (n)));
adc02cce 221#endif
1be6b49c
ML
222 args = SCM_CDR (args);
223 for (i = 0; i < SCM_GSUBR_REQ (typ); i++) {
cf7c17e9 224#ifndef SCM_RECKLESS
a4bb4e6d
DH
225 if (SCM_NULLP (args))
226 scm_wrong_num_args (SCM_SNAME (SCM_GSUBR_PROC (self)));
0f2d19dd
JB
227#endif
228 v[i] = SCM_CAR(args);
229 args = SCM_CDR(args);
230 }
1be6b49c
ML
231 for (; i < SCM_GSUBR_REQ (typ) + SCM_GSUBR_OPT (typ); i++) {
232 if (SCM_NIMP (args)) {
233 v[i] = SCM_CAR (args);
0f2d19dd
JB
234 args = SCM_CDR(args);
235 }
236 else
237 v[i] = SCM_UNDEFINED;
238 }
dc0938d8 239 if (SCM_GSUBR_REST(typ))
0f2d19dd 240 v[i] = args;
a4bb4e6d
DH
241 else if (!SCM_NULLP (args))
242 scm_wrong_num_args (SCM_SNAME (SCM_GSUBR_PROC (self)));
0f2d19dd 243 switch (n) {
0f2d19dd
JB
244 case 2: return (*fcn)(v[0], v[1]);
245 case 3: return (*fcn)(v[0], v[1], v[2]);
246 case 4: return (*fcn)(v[0], v[1], v[2], v[3]);
247 case 5: return (*fcn)(v[0], v[1], v[2], v[3], v[4]);
248 case 6: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5]);
249 case 7: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5], v[6]);
250 case 8: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5], v[6], v[7]);
251 case 9: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5], v[6], v[7], v[8]);
252 case 10: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5], v[6], v[7], v[8], v[9]);
253 }
4260a7fc 254 return SCM_BOOL_F; /* Never reached. */
0f2d19dd 255}
a4bb4e6d 256#undef FUNC_NAME
0f2d19dd
JB
257
258
259#ifdef GSUBR_TEST
260/* A silly example, taking 2 required args, 1 optional, and
261 a scm_list of rest args
262 */
263SCM
1bbd0b84 264gsubr_21l(SCM req1, SCM req2, SCM opt, SCM rst)
0f2d19dd 265{
b7f3516f 266 scm_puts ("gsubr-2-1-l:\n req1: ", scm_cur_outp);
0f2d19dd 267 scm_display(req1, scm_cur_outp);
b7f3516f 268 scm_puts ("\n req2: ", scm_cur_outp);
0f2d19dd 269 scm_display(req2, scm_cur_outp);
b7f3516f 270 scm_puts ("\n opt: ", scm_cur_outp);
0f2d19dd 271 scm_display(opt, scm_cur_outp);
b7f3516f 272 scm_puts ("\n rest: ", scm_cur_outp);
0f2d19dd
JB
273 scm_display(rst, scm_cur_outp);
274 scm_newline(scm_cur_outp);
275 return SCM_UNSPECIFIED;
276}
277#endif
278
279
0f2d19dd
JB
280void
281scm_init_gsubr()
0f2d19dd 282{
9d78586f
MV
283 scm_f_gsubr_apply = scm_c_make_subr ("gsubr-apply", scm_tc7_lsubr,
284 scm_gsubr_apply);
0f2d19dd 285#ifdef GSUBR_TEST
9d78586f 286 scm_c_define_gsubr ("gsubr-2-1-l", 2, 1, 1, gsubr_21l); /* example */
0f2d19dd 287#endif
85db4a2c
DH
288
289#ifndef SCM_MAGIC_SNARFER
290#include "libguile/gsubr.x"
291#endif
0f2d19dd 292}
89e00824
ML
293
294/*
295 Local Variables:
296 c-file-style: "gnu"
297 End:
298*/