libguile/gsubr.c

   1 /*      Copyright (C) 1995,1996,1997,1998, 1999, 2000 Free Software Foundation, Inc.
   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
  15  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  16  * Boston, MA 02111-1307 USA
  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.
  40  * If you do not wish that, delete this exception notice.  */
  41
  42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
  43    gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
  44
  45 \f
  46
  47 #include <stdio.h>
  48 #include "libguile/_scm.h"
  49 #include "libguile/procprop.h"
  50 #include "libguile/root.h"
  51
  52 #include "libguile/gsubr.h"
  53 \f
  54 /*
  55  * gsubr.c
  56  * Provide `gsubrs' -- subrs taking a prescribed number of required, optional,
  57  * and rest arguments.
  58  */
  59
  60 /* #define GSUBR_TEST */
  61
  62 SCM_GLOBAL_SYMBOL (scm_sym_name, "name");
  63
  64 SCM scm_f_gsubr_apply;
  65
  66 SCM
  67 scm_make_gsubr(const char *name,int req,int opt,int rst,SCM (*fcn)())
  68 {
  69   switch SCM_GSUBR_MAKTYPE(req, opt, rst) {
  70   case SCM_GSUBR_MAKTYPE(0, 0, 0): return scm_make_subr(name, scm_tc7_subr_0, fcn);
  71   case SCM_GSUBR_MAKTYPE(1, 0, 0): return scm_make_subr(name, scm_tc7_subr_1, fcn);
  72   case SCM_GSUBR_MAKTYPE(0, 1, 0): return scm_make_subr(name, scm_tc7_subr_1o, fcn);
  73   case SCM_GSUBR_MAKTYPE(1, 1, 0): return scm_make_subr(name, scm_tc7_subr_2o, fcn);
  74   case SCM_GSUBR_MAKTYPE(2, 0, 0): return scm_make_subr(name, scm_tc7_subr_2, fcn);
  75   case SCM_GSUBR_MAKTYPE(3, 0, 0): return scm_make_subr(name, scm_tc7_subr_3, fcn);
  76   case SCM_GSUBR_MAKTYPE(0, 0, 1): return scm_make_subr(name, scm_tc7_lsubr, fcn);
  77   case SCM_GSUBR_MAKTYPE(2, 0, 1): return scm_make_subr(name, scm_tc7_lsubr_2, fcn);
  78   default:
  79     {
  80       SCM sym = scm_str2symbol (name);
  81       SCM var = scm_sym2var (sym, scm_current_module_lookup_closure (),
  82                              SCM_BOOL_T);
  83       SCM cclo = scm_makcclo (scm_f_gsubr_apply, 3L);
  84       if (SCM_GSUBR_MAX < req + opt + rst) {
  85         fputs("ERROR in scm_make_gsubr: too many args\n", stderr);
  86         exit (1);
  87       }
  88       SCM_SET_GSUBR_PROC (cclo, scm_make_subr_opt (name, scm_tc7_subr_0, fcn, 0));
  89       SCM_SET_GSUBR_TYPE (cclo, SCM_MAKINUM (SCM_GSUBR_MAKTYPE (req, opt, rst)));
  90       SCM_VARIABLE_SET (var, cclo);
  91 #ifdef DEBUG_EXTENSIONS
  92       if (SCM_REC_PROCNAMES_P)
  93         scm_set_procedure_property_x (cclo, scm_sym_name, sym);
  94 #endif
  95       return cclo;
  96     }
  97   }
  98 }
  99
 100 SCM
 101 scm_make_gsubr_with_generic (const char *name,
 102                              int req,
 103                              int opt,
 104                              int rst,
 105                              SCM (*fcn)(),
 106                              SCM *gf)
 107 {
 108   switch SCM_GSUBR_MAKTYPE(req, opt, rst) {
 109   case SCM_GSUBR_MAKTYPE(0, 0, 0):
 110     return scm_make_subr_with_generic(name, scm_tc7_subr_0, fcn, gf);
 111   case SCM_GSUBR_MAKTYPE(1, 0, 0):
 112     return scm_make_subr_with_generic(name, scm_tc7_subr_1, fcn, gf);
 113   case SCM_GSUBR_MAKTYPE(0, 1, 0):
 114     return scm_make_subr_with_generic(name, scm_tc7_subr_1o, fcn, gf);
 115   case SCM_GSUBR_MAKTYPE(1, 1, 0):
 116     return scm_make_subr_with_generic(name, scm_tc7_subr_2o, fcn, gf);
 117   case SCM_GSUBR_MAKTYPE(2, 0, 0):
 118     return scm_make_subr_with_generic(name, scm_tc7_subr_2, fcn, gf);
 119   case SCM_GSUBR_MAKTYPE(3, 0, 0):
 120     return scm_make_subr_with_generic(name, scm_tc7_subr_3, fcn, gf);
 121   case SCM_GSUBR_MAKTYPE(0, 0, 1):
 122     return scm_make_subr_with_generic(name, scm_tc7_lsubr, fcn, gf);
 123   case SCM_GSUBR_MAKTYPE(2, 0, 1):
 124     return scm_make_subr_with_generic(name, scm_tc7_lsubr_2, fcn, gf);
 125   default:
 126     ;
 127   }
 128   scm_misc_error ("scm_make_gsubr_with_generic",
 129                   "can't make primitive-generic with this arity",
 130                   SCM_EOL);
 131   return SCM_BOOL_F; /* never reached */
 132 }
 133
 134
 135 SCM
 136 scm_gsubr_apply (SCM args)
 137 #define FUNC_NAME "scm_gsubr_apply"
 138 {
 139   SCM self = SCM_CAR(args);
 140   SCM (*fcn)() = SCM_SUBRF(SCM_GSUBR_PROC(self));
 141   SCM v[SCM_GSUBR_MAX];
 142   int typ = SCM_INUM(SCM_GSUBR_TYPE(self));
 143   int i, n = SCM_GSUBR_REQ(typ) + SCM_GSUBR_OPT(typ) + SCM_GSUBR_REST(typ);
 144 #if 0
 145   if (n > SCM_GSUBR_MAX)
 146     scm_misc_error (FUNC_NAME,
 147                     "Function ~S has illegal arity ~S.",
 148                     SCM_LIST2 (self, SCM_MAKINUM (n)));
 149 #endif
 150   args = SCM_CDR(args);
 151   for (i = 0; i < SCM_GSUBR_REQ(typ); i++) {
 152 #ifndef SCM_RECKLESS
 153     if (SCM_NULLP (args))
 154       scm_wrong_num_args (SCM_SNAME (SCM_GSUBR_PROC (self)));
 155 #endif
 156     v[i] = SCM_CAR(args);
 157     args = SCM_CDR(args);
 158   }
 159   for (; i < SCM_GSUBR_REQ(typ) + SCM_GSUBR_OPT(typ); i++) {
 160     if (SCM_NIMP(args)) {
 161       v[i] = SCM_CAR(args);
 162       args = SCM_CDR(args);
 163     }
 164     else
 165       v[i] = SCM_UNDEFINED;
 166   }
 167   if (SCM_GSUBR_REST(typ))
 168     v[i] = args;
 169   else if (!SCM_NULLP (args))
 170     scm_wrong_num_args (SCM_SNAME (SCM_GSUBR_PROC (self)));
 171   switch (n) {
 172   case 2: return (*fcn)(v[0], v[1]);
 173   case 3: return (*fcn)(v[0], v[1], v[2]);
 174   case 4: return (*fcn)(v[0], v[1], v[2], v[3]);
 175   case 5: return (*fcn)(v[0], v[1], v[2], v[3], v[4]);
 176   case 6: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5]);
 177   case 7: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5], v[6]);
 178   case 8: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5], v[6], v[7]);
 179   case 9: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5], v[6], v[7], v[8]);
 180   case 10: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5], v[6], v[7], v[8], v[9]);
 181   }
 182   return SCM_BOOL_F; /* Never reached. */
 183 }
 184 #undef FUNC_NAME
 185
 186
 187 #ifdef GSUBR_TEST
 188 /* A silly example, taking 2 required args, 1 optional, and
 189    a scm_list of rest args
 190    */
 191 SCM
 192 gsubr_21l(SCM req1, SCM req2, SCM opt, SCM rst)
 193 {
 194   scm_puts ("gsubr-2-1-l:\n req1: ", scm_cur_outp);
 195   scm_display(req1, scm_cur_outp);
 196   scm_puts ("\n req2: ", scm_cur_outp);
 197   scm_display(req2, scm_cur_outp);
 198   scm_puts ("\n opt: ", scm_cur_outp);
 199   scm_display(opt, scm_cur_outp);
 200   scm_puts ("\n rest: ", scm_cur_outp);
 201   scm_display(rst, scm_cur_outp);
 202   scm_newline(scm_cur_outp);
 203   return SCM_UNSPECIFIED;
 204 }
 205 #endif
 206
 207
 208
 209 void
 210 scm_init_gsubr()
 211 {
 212   scm_f_gsubr_apply = scm_make_subr_opt("gsubr-apply", scm_tc7_lsubr, scm_gsubr_apply, 0);
 213
 214 #ifdef GSUBR_TEST
 215   scm_make_gsubr("gsubr-2-1-l", 2, 1, 1, gsubr_21l); /* example */
 216 #endif
 217
 218 #ifndef SCM_MAGIC_SNARFER
 219 #include "libguile/gsubr.x"
 220 #endif
 221 }
 222
 223 /*
 224   Local Variables:
 225   c-file-style: "gnu"
 226   End:
 227 */