*** empty log message ***
[bpt/guile.git] / libguile / procs.h
index 332e06c..11cfb1f 100644 (file)
@@ -2,7 +2,7 @@
 
 #ifndef PROCSH
 #define PROCSH
-/*     Copyright (C) 1995,1996 Free Software Foundation, Inc.
+/*     Copyright (C) 1995, 1996, 1998, 1999 Free Software Foundation, Inc.
  * 
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -16,7 +16,8 @@
  * 
  * You should have received a copy of the GNU General Public License
  * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+ * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
+ * Boston, MA 02111-1307 USA
  *
  * As a special exception, the Free Software Foundation gives permission
  * for additional uses of the text contained in its release of GUILE.
  *
  * If you write modifications of your own for GUILE, it is your choice
  * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  
- */
+ * If you do not wish that, delete this exception notice.  */
 \f
 
-#include "__scm.h"
+#include "libguile/__scm.h"
 
 \f
 
@@ -70,11 +70,30 @@ typedef struct scm_dsubr
   double (*dproc) ();
 } scm_dsubr;
 
-#define SCM_SNAME(x) ((SCM_CAR(x)>>8)?(SCM)(scm_heap_org+(SCM_CAR(x)>>8)):scm_nullstr)
+typedef struct
+{
+  SCM handle;                  /* link back to procedure object */
+  SCM name;
+  SCM *generic;                        /* 0 if no generic support
+                                * *generic == 0 until first method
+                                */
+  SCM properties;              /* procedure properties */
+  SCM documentation;
+} scm_subr_entry;
+
+#define SCM_SUBRNUM(subr) (SCM_CAR (subr) >> 8)
+#define SCM_SET_SUBRNUM(subr, num) \
+        SCM_SETCAR (subr, (num >> 8) + SCM_TYP7 (subr))
+#define SCM_SUBR_ENTRY(x) (scm_subr_table[SCM_SUBRNUM (x)])
+#define SCM_SNAME(x) (SCM_SUBR_ENTRY (x).name)
 #define SCM_SUBRF(x) (((scm_subr *)(SCM2PTR(x)))->cproc)
 #define SCM_DSUBRF(x) (((scm_dsubr *)(SCM2PTR(x)))->dproc)
 #define SCM_CCLO_SUBR(x) (SCM_VELTS(x)[0])
 
+#define SCM_SUBR_GENERIC(x) (SCM_SUBR_ENTRY (x).generic)
+#define SCM_SUBR_PROPS(x) (SCM_SUBR_ENTRY (x).properties)
+#define SCM_SUBR_DOC(x) (SCM_SUBR_ENTRY (x).documentation)
+
 /* Closures
  */
 
@@ -82,26 +101,97 @@ typedef struct scm_dsubr
 #define SCM_CLOSCAR(x) (SCM_CAR(x)-scm_tc3_closure)
 #define SCM_CODE(x) SCM_CAR(SCM_CLOSCAR (x))
 #define SCM_PROCPROPS(x) SCM_CDR(SCM_CLOSCAR (x))
-#define SCM_SETCODE(x, e) SCM_CAR(x) = (scm_cons ((e), SCM_EOL) + scm_tc3_closure)
+#define SCM_SETPROCPROPS(x, p) SCM_SETCDR(SCM_CLOSCAR (x), p)
+#define SCM_SETCODE(x, e) (SCM_SETCAR (x, scm_cons ((e), SCM_EOL) + scm_tc3_closure))
 #define SCM_ENV(x) SCM_CDR(x)
+#define SCM_SETENV(x, e) SCM_SETCDR (x, e)
 #define SCM_TOP_LEVEL(SCM_ENV)  (SCM_NULLP(SCM_ENV) || (SCM_BOOL_T == scm_procedure_p (SCM_CAR (SCM_ENV))))
 
+/* Procedure-with-setter
+
+   Four representations for procedure-with-setters were
+   considered before selecting this one:
+
+   1. A closure where the CODE and ENV slots are used to represent
+   the getter and a new SETTER slot is used for the setter.  The
+   original getter is stored as a `getter' procedure property.  For
+   closure getters, the CODE and ENV slots contains a copy of the
+   getter's CODE and ENV slots.  For subr getters, the CODE contains
+   a call to the subr.
+
+   2. A compiled closure with a call to the getter in the cclo
+   procedure.  The getter and setter are stored in slots 1 and 2.
+
+   3. An entity (i.e. a struct with an associated procedure) with a
+   call to the getter in the entity procedure and the setter stored
+   in slot 0.  The original getter is stored in slot 1.
+
+   4. A new primitive procedure type supported in the evaluator.  The
+   getter and setter are stored in a GETTER and SETTER slot.  A call
+   to this procedure type results in a retrieval of the getter and a
+   jump back to the correct eval dispatcher.
+
+   Representation 4 was selected because of efficiency and
+   simplicity.
+
+   Rep 1 has the advantage that there is zero penalty for closure
+   getters, but primitive getters will get considerable overhead
+   because the procedure-with-getter will be a closure which calls
+   the getter.
+
+   Rep 3 has the advantage that a GOOPS accessor can be a subclass of
+   <procedure-with-setter>, but together with rep 2 it suffers from a
+   three level dispatch for non-GOOPS getters:
+
+     cclo/struct --> dispatch proc --> getter
+
+   This is because the dispatch procedure must take an extra initial
+   argument (cclo for rep 2, struct for rep 3).
+
+   Rep 4 has the single disadvantage that it uses up one tc7 type
+   code, but the plan for uniform vectors will very likely free tc7
+   codes, so this is probably no big problem.  Also note that the
+   GETTER and SETTER slots can live directly on the heap, using the
+   new four-word cells.  */
+
+#define SCM_PROCEDURE_WITH_SETTER_P(obj) (SCM_TYP7 (obj) == scm_tc7_pws)
+#define SCM_PROCEDURE(obj) SCM_CADR (obj)
+#define SCM_SETTER(obj) SCM_CDDR (obj)
+
+extern scm_subr_entry *scm_subr_table;
+extern int scm_subr_table_size;
+extern int scm_subr_table_room;
+
 \f
 
+extern void scm_mark_subr_table (void);
+extern void scm_free_subr_entry (SCM subr);
+extern SCM scm_make_subr SCM_P ((const char *name, int type, SCM (*fcn) ()));
+extern SCM scm_make_subr_with_generic (const char *name,
+                                      int type,
+                                      SCM (*fcn) (),
+                                      SCM *gf);
+extern SCM scm_make_subr_opt SCM_P ((const char *name, 
+                                    int type, 
+                                    SCM (*fcn) (),
+                                    int set));
+extern SCM scm_makcclo SCM_P ((SCM proc, long len));
+extern SCM scm_procedure_p SCM_P ((SCM obj));
+extern SCM scm_closure_p SCM_P ((SCM obj));
+extern SCM scm_thunk_p SCM_P ((SCM obj));
+extern int scm_subr_p (SCM obj);
+extern SCM scm_procedure_documentation SCM_P ((SCM proc));
+extern SCM scm_procedure_with_setter_p SCM_P ((SCM obj));
+extern SCM scm_make_procedure_with_setter SCM_P ((SCM procedure, SCM setter));
+extern SCM scm_procedure SCM_P ((SCM proc));
+extern SCM scm_setter SCM_P ((SCM proc));
+extern void scm_init_iprocs SCM_P ((const scm_iproc *subra, int type));
+extern void scm_init_subr_table (void);
+extern void scm_init_procs SCM_P ((void));
+
+#ifdef GUILE_DEBUG
+extern SCM scm_make_cclo SCM_P ((SCM proc, SCM len));
+#endif /*GUILE_DEBUG*/
+
 \f
-#ifdef __STDC__
-extern SCM scm_make_subr (char *name, int type, SCM (*fcn) ());
-extern SCM scm_makcclo (SCM proc, long len);
-extern SCM scm_procedure_p (SCM obj);
-extern void scm_init_iprocs(scm_iproc *subra, int type);
-extern void scm_init_procs (void);
-
-#else /* STDC */
-extern SCM scm_make_subr ();
-extern SCM scm_makcclo ();
-extern SCM scm_procedure_p ();
-extern void scm_init_iprocs();
-extern void scm_init_procs ();
-
-#endif /* STDC */
 #endif  /* PROCSH */