*** empty log message ***

[bpt/guile.git] / libguile / smob.h

diff --git a/libguile/smob.h b/libguile/smob.h
index 30c9d01..b6de488 100644 (file)
--- a/libguile/smob.h
+++ b/libguile/smob.h
@@ -57,6 +57,8 @@ typedef struct scm_smob_descriptor
   scm_sizet (*free) (SCM);
   int (*print) (SCM exp, SCM port, scm_print_state *pstate);
   SCM (*equalp) (SCM, SCM);
+  SCM (*apply) ();
+  int gsubr_type;
 } scm_smob_descriptor;
 
 \f
@@ -112,6 +114,7 @@ do { \
 #define SCM_SMOBNAME(smobnum)          (scm_smobs[smobnum].name)
 #define SCM_SMOB_PREDICATE(tag, obj)   (SCM_NIMP (obj) \
                                         && SCM_TYP16 (obj) == (tag))
+#define SCM_SMOB_DESCRIPTOR(x)         (scm_smobs[SCM_SMOBNUM (x)])
 
 extern int scm_numsmob;
 extern scm_smob_descriptor *scm_smobs;
@@ -124,38 +127,49 @@ extern scm_sizet scm_free0 (SCM ptr);
 extern scm_sizet scm_smob_free (SCM obj);
 extern int scm_smob_print (SCM exp, SCM port, scm_print_state *pstate);
 
-/* These next two functions are the supported way to create new SMOB types.
- 
-   scm_make_smob_type is useful if there are no special smob functions
-     and the defaults work for mark,free,print,equal_p, or you want to use
-     scm_set_smob_{mark,free,print,equalp}, below.
+extern SCM scm_smob_apply_0 (SCM smob);
+extern SCM scm_smob_apply_1 (SCM smob, SCM a1);
+extern SCM scm_smob_apply_2 (SCM smob, SCM a1, SCM a2);
+extern SCM scm_smob_apply_3 (SCM smob, SCM a1, SCM a2, SCM rest);
 
-   scm_make_smob_type_mfpe is ideal if you need to set one or more of
-     the special smob functions-- use NULL for when the default function 
-     is fine 
-*/
+/* The following set of functions is the standard way to create new
+ * SMOB types.
+ *
+ * Create a type tag using `scm_make_smob_type', accept default values
+ * for mark, free, print and/or equalp functions, or set your own
+ * values using `scm_set_smob_xxx'.
+ */
 
 extern long scm_make_smob_type (char *name, scm_sizet size);
 
-extern long scm_make_smob_type_mfpe (char *name, scm_sizet size,
-                                    SCM (*mark) (SCM),
-                                    scm_sizet (*free) (SCM),
-                                    int (*print) (SCM, SCM, scm_print_state*),
-                                    SCM (*equalp) (SCM, SCM));
-
 extern void scm_set_smob_mark (long tc, SCM (*mark) (SCM));
 extern void scm_set_smob_free (long tc, scm_sizet (*free) (SCM));
 extern void scm_set_smob_print (long tc, int (*print) (SCM,
                                                       SCM,
                                                       scm_print_state*));
 extern void scm_set_smob_equalp (long tc, SCM (*equalp) (SCM, SCM));
-/* convenience function for registering multiple handler fns */
+extern void scm_set_smob_apply (long tc, SCM (*apply) (), int req, int opt, int rst);
+
+
+/* Functions for registering multiple handler functions simultaneously.
+ *
+ * (There is a discussion among the developers whether or not these
+ *  should be deprecated in the future.)
+ */
+
+extern long scm_make_smob_type_mfpe (char *name, scm_sizet size,
+                                    SCM (*mark) (SCM),
+                                    scm_sizet (*free) (SCM),
+                                    int (*print) (SCM, SCM, scm_print_state*),
+                                    SCM (*equalp) (SCM, SCM));
+
 extern void scm_set_smob_mfpe (long tc, 
                               SCM (*mark) (SCM),
                               scm_sizet (*free) (SCM),
                               int (*print) (SCM, SCM, scm_print_state*),
                               SCM (*equalp) (SCM, SCM));
 
+/* Function for creating smobs */
 
 extern SCM scm_make_smob (long tc);
 extern void scm_smob_prehistory (void);