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 static SCM
  67 create_gsubr (int define, const char *name,
  68               int req, int opt, int rst, SCM (*fcn)())
  69 {
  70   SCM subr;
  71
  72   switch (SCM_GSUBR_MAKTYPE (req, opt, rst))
  73     {
  74     case SCM_GSUBR_MAKTYPE(0, 0, 0):
  75       subr = scm_c_make_subr (name, scm_tc7_subr_0, fcn);
  76       goto create_subr;
  77     case SCM_GSUBR_MAKTYPE(1, 0, 0):
  78       subr = scm_c_make_subr (name, scm_tc7_subr_1, fcn);
  79       goto create_subr;
  80     case SCM_GSUBR_MAKTYPE(0, 1, 0):
  81       subr = scm_c_make_subr (name, scm_tc7_subr_1o, fcn);
  82       goto create_subr;
  83     case SCM_GSUBR_MAKTYPE(1, 1, 0):
  84       subr = scm_c_make_subr (name, scm_tc7_subr_2o, fcn);
  85       goto create_subr;
  86     case SCM_GSUBR_MAKTYPE(2, 0, 0):
  87       subr = scm_c_make_subr (name, scm_tc7_subr_2, fcn);
  88       goto create_subr;
  89     case SCM_GSUBR_MAKTYPE(3, 0, 0):
  90       subr = scm_c_make_subr (name, scm_tc7_subr_3, fcn);
  91       goto create_subr;
  92     case SCM_GSUBR_MAKTYPE(0, 0, 1):
  93       subr = scm_c_make_subr (name, scm_tc7_lsubr, fcn);
  94       goto create_subr;
  95     case SCM_GSUBR_MAKTYPE(2, 0, 1):
  96       subr = scm_c_make_subr (name, scm_tc7_lsubr_2, fcn);
  97     create_subr:
  98       if (define)
  99         scm_define (SCM_SUBR_ENTRY(subr).name, subr);
 100       return subr;
 101     default:
 102       {
 103         SCM cclo = scm_makcclo (scm_f_gsubr_apply, 3L);
 104         SCM subr = scm_c_make_subr (name, scm_tc7_subr_0, fcn);
 105         SCM sym = SCM_SUBR_ENTRY(subr).name;
 106         if (SCM_GSUBR_MAX < req + opt + rst)
 107           {
 108             fputs ("ERROR in scm_c_make_gsubr: too many args\n", stderr);
 109             exit (1);
 110           }
 111         SCM_SET_GSUBR_PROC (cclo, subr);
 112         SCM_SET_GSUBR_TYPE (cclo,
 113                             SCM_MAKINUM (SCM_GSUBR_MAKTYPE (req, opt, rst)));
 114 #ifdef DEBUG_EXTENSIONS
 115         if (SCM_REC_PROCNAMES_P)
 116           scm_set_procedure_property_x (cclo, scm_sym_name, sym);
 117 #endif
 118         if (define)
 119           scm_define (sym, cclo);
 120       return cclo;
 121       }
 122     }
 123 }
 124
 125 SCM
 126 scm_c_make_gsubr (const char *name, int req, int opt, int rst, SCM (*fcn)())
 127 {
 128   return create_gsubr (0, name, req, opt, rst, fcn);
 129 }
 130
 131 SCM
 132 scm_c_define_gsubr (const char *name, int req, int opt, int rst, SCM (*fcn)())
 133 {
 134   return create_gsubr (1, name, req, opt, rst, fcn);
 135 }
 136
 137 static SCM
 138 create_gsubr_with_generic (int define,
 139                            const char *name,
 140                            int req,
 141                            int opt,
 142                            int rst,
 143                            SCM (*fcn)(),
 144                            SCM *gf)
 145 {
 146   SCM subr;
 147
 148   switch (SCM_GSUBR_MAKTYPE(req, opt, rst))
 149     {
 150     case SCM_GSUBR_MAKTYPE(0, 0, 0):
 151       subr = scm_c_make_subr_with_generic (name, scm_tc7_subr_0, fcn, gf);
 152       goto create_subr;
 153     case SCM_GSUBR_MAKTYPE(1, 0, 0):
 154       subr = scm_c_make_subr_with_generic (name, scm_tc7_subr_1, fcn, gf);
 155       goto create_subr;
 156     case SCM_GSUBR_MAKTYPE(0, 1, 0):
 157       subr = scm_c_make_subr_with_generic (name, scm_tc7_subr_1o, fcn, gf);
 158       goto create_subr;
 159     case SCM_GSUBR_MAKTYPE(1, 1, 0):
 160       subr = scm_c_make_subr_with_generic (name, scm_tc7_subr_2o, fcn, gf);
 161       goto create_subr;
 162     case SCM_GSUBR_MAKTYPE(2, 0, 0):
 163       subr = scm_c_make_subr_with_generic (name, scm_tc7_subr_2, fcn, gf);
 164       goto create_subr;
 165     case SCM_GSUBR_MAKTYPE(3, 0, 0):
 166       subr = scm_c_make_subr_with_generic (name, scm_tc7_subr_3, fcn, gf);
 167       goto create_subr;
 168     case SCM_GSUBR_MAKTYPE(0, 0, 1):
 169       subr = scm_c_make_subr_with_generic (name, scm_tc7_lsubr, fcn, gf);
 170       goto create_subr;
 171     case SCM_GSUBR_MAKTYPE(2, 0, 1):
 172       subr = scm_c_make_subr_with_generic (name, scm_tc7_lsubr_2, fcn, gf);
 173     create_subr:
 174       if (define)
 175         scm_define (SCM_SUBR_ENTRY(subr).name, subr);
 176       return subr;
 177     default:
 178       ;
 179     }
 180   scm_misc_error ("scm_c_make_gsubr_with_generic",
 181                   "can't make primitive-generic with this arity",
 182                   SCM_EOL);
 183   return SCM_BOOL_F; /* never reached */
 184 }
 185
 186 SCM
 187 scm_c_make_gsubr_with_generic (const char *name,
 188                                int req,
 189                                int opt,
 190                                int rst,
 191                                SCM (*fcn)(),
 192                                SCM *gf)
 193 {
 194   return create_gsubr_with_generic (0, name, req, opt, rst, fcn, gf);
 195 }
 196
 197 SCM
 198 scm_c_define_gsubr_with_generic (const char *name,
 199                                  int req,
 200                                  int opt,
 201                                  int rst,
 202                                  SCM (*fcn)(),
 203                                  SCM *gf)
 204 {
 205   return create_gsubr_with_generic (1, name, req, opt, rst, fcn, gf);
 206 }
 207
 208
 209 SCM
 210 scm_gsubr_apply (SCM args)
 211 #define FUNC_NAME "scm_gsubr_apply"
 212 {
 213   SCM self = SCM_CAR(args);
 214   SCM (*fcn)() = SCM_SUBRF(SCM_GSUBR_PROC(self));
 215   SCM v[SCM_GSUBR_MAX];
 216   int typ = SCM_INUM(SCM_GSUBR_TYPE(self));
 217   int i, n = SCM_GSUBR_REQ(typ) + SCM_GSUBR_OPT(typ) + SCM_GSUBR_REST(typ);
 218 #if 0
 219   if (n > SCM_GSUBR_MAX)
 220     scm_misc_error (FUNC_NAME,
 221                     "Function ~S has illegal arity ~S.",
 222                     SCM_LIST2 (self, SCM_MAKINUM (n)));
 223 #endif
 224   args = SCM_CDR(args);
 225   for (i = 0; i < SCM_GSUBR_REQ(typ); i++) {
 226 #ifndef SCM_RECKLESS
 227     if (SCM_NULLP (args))
 228       scm_wrong_num_args (SCM_SNAME (SCM_GSUBR_PROC (self)));
 229 #endif
 230     v[i] = SCM_CAR(args);
 231     args = SCM_CDR(args);
 232   }
 233   for (; i < SCM_GSUBR_REQ(typ) + SCM_GSUBR_OPT(typ); i++) {
 234     if (SCM_NIMP(args)) {
 235       v[i] = SCM_CAR(args);
 236       args = SCM_CDR(args);
 237     }
 238     else
 239       v[i] = SCM_UNDEFINED;
 240   }
 241   if (SCM_GSUBR_REST(typ))
 242     v[i] = args;
 243   else if (!SCM_NULLP (args))
 244     scm_wrong_num_args (SCM_SNAME (SCM_GSUBR_PROC (self)));
 245   switch (n) {
 246   case 2: return (*fcn)(v[0], v[1]);
 247   case 3: return (*fcn)(v[0], v[1], v[2]);
 248   case 4: return (*fcn)(v[0], v[1], v[2], v[3]);
 249   case 5: return (*fcn)(v[0], v[1], v[2], v[3], v[4]);
 250   case 6: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5]);
 251   case 7: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5], v[6]);
 252   case 8: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5], v[6], v[7]);
 253   case 9: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5], v[6], v[7], v[8]);
 254   case 10: return (*fcn)(v[0], v[1], v[2], v[3], v[4], v[5], v[6], v[7], v[8], v[9]);
 255   }
 256   return SCM_BOOL_F; /* Never reached. */
 257 }
 258 #undef FUNC_NAME
 259
 260
 261 #ifdef GSUBR_TEST
 262 /* A silly example, taking 2 required args, 1 optional, and
 263    a scm_list of rest args
 264    */
 265 SCM
 266 gsubr_21l(SCM req1, SCM req2, SCM opt, SCM rst)
 267 {
 268   scm_puts ("gsubr-2-1-l:\n req1: ", scm_cur_outp);
 269   scm_display(req1, scm_cur_outp);
 270   scm_puts ("\n req2: ", scm_cur_outp);
 271   scm_display(req2, scm_cur_outp);
 272   scm_puts ("\n opt: ", scm_cur_outp);
 273   scm_display(opt, scm_cur_outp);
 274   scm_puts ("\n rest: ", scm_cur_outp);
 275   scm_display(rst, scm_cur_outp);
 276   scm_newline(scm_cur_outp);
 277   return SCM_UNSPECIFIED;
 278 }
 279 #endif
 280
 281
 282
 283 void
 284 scm_init_gsubr()
 285 {
 286   scm_f_gsubr_apply = scm_c_make_subr ("gsubr-apply", scm_tc7_lsubr,
 287                                        scm_gsubr_apply);
 288 #ifdef GSUBR_TEST
 289   scm_c_define_gsubr ("gsubr-2-1-l", 2, 1, 1, gsubr_21l); /* example */
 290 #endif
 291
 292 #ifndef SCM_MAGIC_SNARFER
 293 #include "libguile/gsubr.x"
 294 #endif
 295 }
 296
 297 #if SCM_DEBUG_DEPRECATED == 0
 298
 299 SCM
 300 scm_make_gsubr (const char *name, int req, int opt, int rst, SCM (*fcn)())
 301 {
 302   scm_c_issue_deprecation_warning
 303     ("`scm_make_gsubr' is deprecated.  Use `scm_c_define_gsubr' instead.");
 304
 305   return scm_c_define_gsubr (name, req, opt, rst, fcn);
 306 }
 307
 308 SCM
 309 scm_make_gsubr_with_generic (const char *name,
 310                              int req, int opt, int rst,
 311                              SCM (*fcn)(), SCM *gf)
 312 {
 313   scm_c_issue_deprecation_warning
 314     ("`scm_make_gsubr_with_generic' is deprecated.  "
 315      "Use `scm_c_define_gsubr_with_generic' instead.");
 316
 317   return scm_c_define_gsubr_with_generic (name, req, opt, rst, fcn, gf);
 318 }
 319
 320 #endif /* !SCM_DEBUG_DEPRECATED */
 321
 322
 323 /*
 324   Local Variables:
 325   c-file-style: "gnu"
 326   End:
 327 */