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