libguile/procs.c

   1 /*      Copyright (C) 1995, 1996, 1997, 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
  50 #include "libguile/objects.h"
  51 #include "libguile/strings.h"
  52 #include "libguile/vectors.h"
  53 #include "libguile/smob.h"
  54
  55 #include "libguile/validate.h"
  56 #include "libguile/procs.h"
  57 \f
  58
  59
  60 /* {Procedures}
  61  */
  62
  63 scm_subr_entry *scm_subr_table;
  64
  65 /* libguile contained approx. 700 primitive procedures on 24 Aug 1999. */
  66
  67 int scm_subr_table_size = 0;
  68 int scm_subr_table_room = 750;
  69
  70 SCM
  71 scm_make_subr_opt (const char *name, int type, SCM (*fcn) (), int set)
  72 {
  73   SCM symbol;
  74   SCM symcell;
  75   register SCM z;
  76   int entry;
  77
  78   if (scm_subr_table_size == scm_subr_table_room)
  79     {
  80       scm_sizet new_size = scm_subr_table_room * 3 / 2;
  81       void *new_table
  82         = scm_must_realloc ((char *) scm_subr_table,
  83                             sizeof (scm_subr_entry) * scm_subr_table_room,
  84                             sizeof (scm_subr_entry) * new_size,
  85                             "scm_subr_table");
  86       scm_subr_table = new_table;
  87       scm_subr_table_room = new_size;
  88     }
  89
  90   SCM_NEWCELL (z);
  91   if (set)
  92     {
  93       symcell = scm_sysintern (name, SCM_UNDEFINED);
  94       symbol = SCM_CAR (symcell);
  95     }
  96   else
  97     {
  98       symbol = scm_str2symbol (name);
  99     }
 100
 101   entry = scm_subr_table_size;
 102   scm_subr_table[entry].handle = z;
 103   scm_subr_table[entry].name = symbol;
 104   scm_subr_table[entry].generic = 0;
 105
 106   SCM_SET_SUBRF (z, fcn);
 107   SCM_SET_CELL_TYPE (z, (entry << 8) + type);
 108   scm_subr_table_size++;
 109
 110   if (set)
 111     SCM_SETCDR (symcell, z);
 112
 113   return z;
 114 }
 115
 116 /* This function isn't currently used since subrs are never freed. */
 117 /* *fixme* Need mutex here. */
 118 void
 119 scm_free_subr_entry (SCM subr)
 120 {
 121   int entry = SCM_SUBRNUM (subr);
 122   /* Move last entry in table to the free position */
 123   scm_subr_table[entry] = scm_subr_table[scm_subr_table_size - 1];
 124   SCM_SET_SUBRNUM (scm_subr_table[entry].handle, entry);
 125   scm_subr_table_size--;
 126 }
 127
 128 SCM
 129 scm_make_subr (const char *name, int type, SCM (*fcn) ())
 130 {
 131   return scm_make_subr_opt (name, type, fcn, 1);
 132 }
 133
 134 SCM
 135 scm_make_subr_with_generic (const char *name, int type, SCM (*fcn) (), SCM *gf)
 136 {
 137   SCM subr = scm_make_subr_opt (name, type, fcn, 1);
 138   scm_subr_table[scm_subr_table_size - 1].generic = gf;
 139   return subr;
 140 }
 141
 142 void
 143 scm_mark_subr_table ()
 144 {
 145   int i;
 146   for (i = 0; i < scm_subr_table_size; ++i)
 147     {
 148       SCM_SETGCMARK (scm_subr_table[i].name);
 149       if (scm_subr_table[i].generic && *scm_subr_table[i].generic)
 150         scm_gc_mark (*scm_subr_table[i].generic);
 151     }
 152 }
 153
 154
 155 #ifdef CCLO
 156 SCM
 157 scm_makcclo (SCM proc, long len)
 158 {
 159   scm_bits_t *base = scm_must_malloc (len * sizeof (scm_bits_t), "compiled-closure");
 160   unsigned long i;
 161   SCM s;
 162
 163   for (i = 0; i < len; ++i)
 164     base [i] = SCM_UNPACK (SCM_UNSPECIFIED);
 165
 166   SCM_NEWCELL (s);
 167   SCM_DEFER_INTS;
 168   SCM_SET_CCLO_BASE (s, base);
 169   SCM_SET_CCLO_LENGTH (s, len);
 170   SCM_SET_CCLO_SUBR (s, proc);
 171   SCM_ALLOW_INTS;
 172   return s;
 173 }
 174
 175 /* Undocumented debugging procedure */
 176 #ifdef GUILE_DEBUG
 177 SCM_DEFINE (scm_make_cclo, "make-cclo", 2, 0, 0,
 178             (SCM proc, SCM len),
 179 "")
 180 #define FUNC_NAME s_scm_make_cclo
 181 {
 182   return scm_makcclo (proc, SCM_INUM (len));
 183 }
 184 #undef FUNC_NAME
 185 #endif
 186 #endif
 187
 188
 189
 190 SCM_DEFINE (scm_procedure_p, "procedure?", 1, 0, 0,
 191            (SCM obj),
 192 "")
 193 #define FUNC_NAME s_scm_procedure_p
 194 {
 195   if (SCM_NIMP (obj))
 196     switch (SCM_TYP7 (obj))
 197       {
 198       case scm_tcs_cons_gloc:
 199         if (!SCM_I_OPERATORP (obj))
 200           break;
 201       case scm_tcs_closures:
 202       case scm_tcs_subrs:
 203 #ifdef CCLO
 204       case scm_tc7_cclo:
 205 #endif
 206       case scm_tc7_pws:
 207         return SCM_BOOL_T;
 208       case scm_tc7_smob:
 209         return SCM_BOOL (SCM_SMOB_DESCRIPTOR (obj).apply);
 210       default:
 211         return SCM_BOOL_F;
 212       }
 213   return SCM_BOOL_F;
 214 }
 215 #undef FUNC_NAME
 216
 217 SCM_DEFINE (scm_closure_p, "closure?", 1, 0, 0,
 218            (SCM obj),
 219 "")
 220 #define FUNC_NAME s_scm_closure_p
 221 {
 222   return SCM_BOOL(SCM_CLOSUREP (obj));
 223 }
 224 #undef FUNC_NAME
 225
 226 SCM_DEFINE (scm_thunk_p, "thunk?", 1, 0, 0,
 227            (SCM obj),
 228 "")
 229 #define FUNC_NAME s_scm_thunk_p
 230 {
 231   if (SCM_NIMP (obj))
 232     {
 233     again:
 234       switch (SCM_TYP7 (obj))
 235         {
 236         case scm_tcs_closures:
 237           if (SCM_NULLP (SCM_CAR (SCM_CODE (obj))))
 238             return SCM_BOOL_T;
 239         case scm_tc7_subr_0:
 240         case scm_tc7_subr_1o:
 241         case scm_tc7_lsubr:
 242         case scm_tc7_rpsubr:
 243         case scm_tc7_asubr:
 244 #ifdef CCLO
 245         case scm_tc7_cclo:
 246 #endif
 247           return SCM_BOOL_T;
 248         case scm_tc7_pws:
 249           obj = SCM_PROCEDURE (obj);
 250           goto again;
 251         default:
 252           ;
 253         }
 254     }
 255   return SCM_BOOL_F;
 256 }
 257 #undef FUNC_NAME
 258
 259 /* Only used internally. */
 260 int
 261 scm_subr_p (SCM obj)
 262 {
 263   if (SCM_NIMP (obj))
 264     switch (SCM_TYP7 (obj))
 265       {
 266       case scm_tcs_subrs:
 267         return 1;
 268       default:
 269         ;
 270       }
 271   return 0;
 272 }
 273
 274 SCM_DEFINE (scm_procedure_documentation, "procedure-documentation", 1, 0, 0,
 275            (SCM proc),
 276             "Return the documentation string associated with @code{proc}.  By\n"
 277             "convention, if a procedure contains more than one expression and the\n"
 278             "first expression is a string constant, that string is assumed to contain\n"
 279             "documentation for that procedure.")
 280 #define FUNC_NAME s_scm_procedure_documentation
 281 {
 282   SCM code;
 283   SCM_ASSERT (SCM_EQ_P (scm_procedure_p (proc), SCM_BOOL_T) && SCM_NIMP (proc),
 284               proc, SCM_ARG1, FUNC_NAME);
 285   switch (SCM_TYP7 (proc))
 286     {
 287     case scm_tcs_closures:
 288       code = SCM_CDR (SCM_CODE (proc));
 289       if (SCM_IMP (SCM_CDR (code)))
 290         return SCM_BOOL_F;
 291       code = SCM_CAR (code);
 292       if (SCM_IMP (code))
 293         return SCM_BOOL_F;
 294       if (SCM_STRINGP (code))
 295         return code;
 296     default:
 297       return SCM_BOOL_F;
 298 /*
 299   case scm_tcs_subrs:
 300 #ifdef CCLO
 301   case scm_tc7_cclo:
 302 #endif
 303 */
 304     }
 305 }
 306 #undef FUNC_NAME
 307
 308
 309 /* Procedure-with-setter
 310  */
 311
 312 SCM_DEFINE (scm_procedure_with_setter_p, "procedure-with-setter?", 1, 0, 0,
 313             (SCM obj),
 314             "")
 315 #define FUNC_NAME s_scm_procedure_with_setter_p
 316 {
 317   return SCM_BOOL(SCM_PROCEDURE_WITH_SETTER_P (obj));
 318 }
 319 #undef FUNC_NAME
 320
 321 SCM_DEFINE (scm_make_procedure_with_setter, "make-procedure-with-setter", 2, 0, 0,
 322             (SCM procedure, SCM setter),
 323             "")
 324 #define FUNC_NAME s_scm_make_procedure_with_setter
 325 {
 326   SCM z;
 327   SCM_VALIDATE_PROC (1, procedure);
 328   SCM_VALIDATE_PROC (2, setter);
 329   SCM_NEWCELL2 (z);
 330   SCM_ENTER_A_SECTION;
 331   SCM_SET_CELL_OBJECT_1 (z, procedure);
 332   SCM_SET_CELL_OBJECT_2 (z, setter);
 333   SCM_SET_CELL_TYPE (z, scm_tc7_pws);
 334   SCM_EXIT_A_SECTION;
 335   return z;
 336 }
 337 #undef FUNC_NAME
 338
 339 SCM_DEFINE (scm_procedure, "procedure", 1, 0, 0,
 340             (SCM proc),
 341             "")
 342 #define FUNC_NAME s_scm_procedure
 343 {
 344   SCM_VALIDATE_NIM (1, proc);
 345   if (SCM_PROCEDURE_WITH_SETTER_P (proc))
 346     return SCM_PROCEDURE (proc);
 347   else if (SCM_STRUCTP (proc))
 348     {
 349       SCM_ASSERT (SCM_I_OPERATORP (proc), proc, SCM_ARG1, FUNC_NAME);
 350       return proc;
 351     }
 352   SCM_WRONG_TYPE_ARG (1, proc);
 353   return SCM_BOOL_F; /* not reached */
 354 }
 355 #undef FUNC_NAME
 356
 357 SCM_GPROC (s_setter, "setter", 1, 0, 0, scm_setter, g_setter);
 358
 359 SCM
 360 scm_setter (SCM proc)
 361 {
 362   SCM_GASSERT1 (SCM_NIMP (proc), g_setter, proc, SCM_ARG1, s_setter);
 363   if (SCM_PROCEDURE_WITH_SETTER_P (proc))
 364     return SCM_SETTER (proc);
 365   else if (SCM_STRUCTP (proc))
 366     {
 367       SCM setter;
 368       SCM_GASSERT1 (SCM_I_OPERATORP (proc),
 369                     g_setter, proc, SCM_ARG1, s_setter);
 370       setter = (SCM_I_ENTITYP (proc)
 371                 ? SCM_ENTITY_SETTER (proc)
 372                 : SCM_OPERATOR_SETTER (proc));
 373       if (SCM_NIMP (setter))
 374         return setter;
 375       /* fall through */
 376     }
 377   SCM_WTA_DISPATCH_1 (g_setter, proc, SCM_ARG1, s_setter);
 378   return SCM_BOOL_F; /* not reached */
 379 }
 380
 381
 382 void
 383 scm_init_subr_table ()
 384 {
 385   scm_subr_table
 386     = ((scm_subr_entry *)
 387        scm_must_malloc (sizeof (scm_subr_entry) * scm_subr_table_room,
 388                         "scm_subr_table"));
 389 }
 390
 391 void
 392 scm_init_procs ()
 393 {
 394 #ifndef SCM_MAGIC_SNARFER
 395 #include "libguile/procs.x"
 396 #endif
 397 }
 398
 399 /*
 400   Local Variables:
 401   c-file-style: "gnu"
 402   End:
 403 */