libguile/procs.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_PROCS_H
   4 #define SCM_PROCS_H
   5
   6 /* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2, or (at your option)
  11  * any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this software; see the file COPYING.  If not, write to
  20  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  21  * Boston, MA 02111-1307 USA
  22  *
  23  * As a special exception, the Free Software Foundation gives permission
  24  * for additional uses of the text contained in its release of GUILE.
  25  *
  26  * The exception is that, if you link the GUILE library with other files
  27  * to produce an executable, this does not by itself cause the
  28  * resulting executable to be covered by the GNU General Public License.
  29  * Your use of that executable is in no way restricted on account of
  30  * linking the GUILE library code into it.
  31  *
  32  * This exception does not however invalidate any other reasons why
  33  * the executable file might be covered by the GNU General Public License.
  34  *
  35  * This exception applies only to the code released by the
  36  * Free Software Foundation under the name GUILE.  If you copy
  37  * code from other Free Software Foundation releases into a copy of
  38  * GUILE, as the General Public License permits, the exception does
  39  * not apply to the code that you add in this way.  To avoid misleading
  40  * anyone as to the status of such modified files, you must delete
  41  * this exception notice from them.
  42  *
  43  * If you write modifications of your own for GUILE, it is your choice
  44  * whether to permit this exception to apply to your modifications.
  45  * If you do not wish that, delete this exception notice.  */
  46
  47 \f
  48
  49 #include "libguile/__scm.h"
  50
  51 \f
  52
  53
  54 /* Subrs
  55  */
  56
  57 typedef struct
  58 {
  59   SCM handle;                   /* link back to procedure object */
  60   SCM name;
  61   SCM *generic;                 /* 0 if no generic support
  62                                  * *generic == 0 until first method
  63                                  */
  64   SCM properties;               /* procedure properties */
  65 } scm_t_subr_entry;
  66
  67 #define SCM_SUBRNUM(subr) (SCM_CELL_WORD_0 (subr) >> 8)
  68 #define SCM_SET_SUBRNUM(subr, num) \
  69         SCM_SET_CELL_WORD_0 (subr, (num << 8) + SCM_TYP7 (subr))
  70 #define SCM_SUBR_ENTRY(x) (scm_subr_table[SCM_SUBRNUM (x)])
  71 #define SCM_SNAME(x) (SCM_SUBR_ENTRY (x).name)
  72 #define SCM_SUBRF(x) ((SCM (*)()) SCM_CELL_WORD_1 (x))
  73 #define SCM_SET_SUBRF(x, v) (SCM_SET_CELL_WORD_1 ((x), (v)))
  74 #define SCM_DSUBRF(x) ((double (*)()) SCM_CELL_WORD_1 (x))
  75 #define SCM_SUBR_PROPS(x) (SCM_SUBR_ENTRY (x).properties)
  76 #define SCM_SUBR_GENERIC(x) (SCM_SUBR_ENTRY (x).generic)
  77
  78 #define SCM_CCLO_LENGTH(x) (SCM_CELL_WORD_0 (x) >> 8)
  79 #define SCM_MAKE_CCLO_TAG(v)  (((v) << 8) + scm_tc7_cclo)
  80 #define SCM_SET_CCLO_LENGTH(x, v) (SCM_SET_CELL_WORD_0 ((x), SCM_MAKE_CCLO_TAG(v)))
  81 #define SCM_CCLO_BASE(x) ((scm_t_bits *) SCM_CELL_WORD_1 (x))
  82 #define SCM_SET_CCLO_BASE(x, v) (SCM_SET_CELL_WORD_1 ((x), (v)))
  83
  84 #define SCM_CCLO_REF(x, i) (SCM_PACK (SCM_CCLO_BASE (x) [i]))
  85 #define SCM_CCLO_SET(x, i, v) (SCM_CCLO_BASE (x) [i] = SCM_UNPACK (v))
  86
  87 #define SCM_CCLO_SUBR(x) (SCM_CCLO_REF ((x), 0))
  88 #define SCM_SET_CCLO_SUBR(x, v) (SCM_CCLO_SET ((x), 0, (v)))
  89
  90 /* Closures
  91  */
  92
  93 #define SCM_CLOSUREP(x) (!SCM_IMP(x) && (SCM_TYP3 (x) == scm_tc3_closure))
  94 #define SCM_CLOSCAR(x) SCM_PACK (SCM_CELL_WORD_0 (x) - scm_tc3_closure)
  95 #define SCM_CODE(x) SCM_CAR (SCM_CLOSCAR (x))
  96 #define SCM_CLOSURE_FORMALS(x) SCM_CAR (SCM_CODE (x))
  97 #define SCM_CLOSURE_BODY(x) SCM_CDR (SCM_CODE (x))
  98 #define SCM_PROCPROPS(x) SCM_CDR (SCM_CLOSCAR (x))
  99 #define SCM_SETPROCPROPS(x, p) SCM_SETCDR (SCM_CLOSCAR (x), p)
 100 #define SCM_SETCODE(x, e) (SCM_SET_CELL_WORD_0 (x, SCM_UNPACK (scm_cons ((e), SCM_EOL)) \
 101                            + scm_tc3_closure))
 102 #define SCM_ENV(x) SCM_CELL_OBJECT_1 (x)
 103 #define SCM_SETENV(x, e) SCM_SET_CELL_OBJECT_1 ((x), (e))
 104 #define SCM_TOP_LEVEL(ENV)  (SCM_NULLP (ENV) || (SCM_EQ_P (scm_procedure_p (SCM_CAR (ENV)), SCM_BOOL_T)))
 105
 106 /* Procedure-with-setter
 107
 108    Four representations for procedure-with-setters were
 109    considered before selecting this one:
 110
 111    1. A closure where the CODE and ENV slots are used to represent
 112    the getter and a new SETTER slot is used for the setter.  The
 113    original getter is stored as a `getter' procedure property.  For
 114    closure getters, the CODE and ENV slots contains a copy of the
 115    getter's CODE and ENV slots.  For subr getters, the CODE contains
 116    a call to the subr.
 117
 118    2. A compiled closure with a call to the getter in the cclo
 119    procedure.  The getter and setter are stored in slots 1 and 2.
 120
 121    3. An entity (i.e. a struct with an associated procedure) with a
 122    call to the getter in the entity procedure and the setter stored
 123    in slot 0.  The original getter is stored in slot 1.
 124
 125    4. A new primitive procedure type supported in the evaluator.  The
 126    getter and setter are stored in a GETTER and SETTER slot.  A call
 127    to this procedure type results in a retrieval of the getter and a
 128    jump back to the correct eval dispatcher.
 129
 130    Representation 4 was selected because of efficiency and
 131    simplicity.
 132
 133    Rep 1 has the advantage that there is zero penalty for closure
 134    getters, but primitive getters will get considerable overhead
 135    because the procedure-with-getter will be a closure which calls
 136    the getter.
 137
 138    Rep 3 has the advantage that a GOOPS accessor can be a subclass of
 139    <procedure-with-setter>, but together with rep 2 it suffers from a
 140    three level dispatch for non-GOOPS getters:
 141
 142      cclo/struct --> dispatch proc --> getter
 143
 144    This is because the dispatch procedure must take an extra initial
 145    argument (cclo for rep 2, struct for rep 3).
 146
 147    Rep 4 has the single disadvantage that it uses up one tc7 type
 148    code, but the plan for uniform vectors will very likely free tc7
 149    codes, so this is probably no big problem.  Also note that the
 150    GETTER and SETTER slots can live directly on the heap, using the
 151    new four-word cells.  */
 152
 153 #define SCM_PROCEDURE_WITH_SETTER_P(obj) (!SCM_IMP(obj) && (SCM_TYP7 (obj) == scm_tc7_pws))
 154 #define SCM_PROCEDURE(obj) SCM_CELL_OBJECT_1 (obj)
 155 #define SCM_SETTER(obj) SCM_CELL_OBJECT_2 (obj)
 156
 157 SCM_API scm_t_subr_entry *scm_subr_table;
 158 SCM_API long scm_subr_table_size;
 159 SCM_API long scm_subr_table_room;
 160
 161 \f
 162
 163 SCM_API void scm_mark_subr_table (void);
 164 SCM_API void scm_free_subr_entry (SCM subr);
 165 SCM_API SCM scm_c_make_subr (const char *name, long type, SCM (*fcn)());
 166 SCM_API SCM scm_c_make_subr_with_generic (const char *name, long type,
 167                                           SCM (*fcn)(), SCM *gf);
 168 SCM_API SCM scm_c_define_subr (const char *name, long type, SCM (*fcn)());
 169 SCM_API SCM scm_c_define_subr_with_generic (const char *name, long type,
 170                                             SCM (*fcn)(), SCM *gf);
 171 SCM_API SCM scm_makcclo (SCM proc, size_t len);
 172 SCM_API SCM scm_procedure_p (SCM obj);
 173 SCM_API SCM scm_closure_p (SCM obj);
 174 SCM_API SCM scm_thunk_p (SCM obj);
 175 SCM_API int scm_subr_p (SCM obj);
 176 SCM_API SCM scm_procedure_documentation (SCM proc);
 177 SCM_API SCM scm_procedure_with_setter_p (SCM obj);
 178 SCM_API SCM scm_make_procedure_with_setter (SCM procedure, SCM setter);
 179 SCM_API SCM scm_procedure (SCM proc);
 180 SCM_API SCM scm_setter (SCM proc);
 181 SCM_API void scm_init_subr_table (void);
 182 SCM_API void scm_init_procs (void);
 183
 184 #ifdef GUILE_DEBUG
 185 SCM_API SCM scm_make_cclo (SCM proc, SCM len);
 186 #endif /*GUILE_DEBUG*/
 187
 188 #endif  /* SCM_PROCS_H */
 189
 190 /*
 191   Local Variables:
 192   c-file-style: "gnu"
 193   End:
 194 */