libguile/procs.c

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