libguile/procs.c

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