Reveal guile-tools's inner simplicity...
[bpt/guile.git] / libguile / smob.h
index 780265f..6a7ceea 100644 (file)
@@ -3,21 +3,23 @@
 #ifndef SCM_SMOB_H
 #define SCM_SMOB_H
 
-/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006 Free Software Foundation, Inc.
+/* Copyright (C) 1995, 1996, 1998, 1999, 2000, 2001, 2004, 2006, 2009,
+ *   2010, 2011 Free Software Foundation, Inc.
  *
  * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 3 of
+ * the License, or (at your option) any later version.
  *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * This library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
  */
 
 \f
@@ -25,6 +27,9 @@
 #include "libguile/__scm.h"
 #include "libguile/print.h"
 
+#include "libguile/bdw-gc.h"
+
+
 \f
 /* This is the internal representation of a smob type */
 
@@ -36,12 +41,8 @@ typedef struct scm_smob_descriptor
   size_t (*free) (SCM);
   int (*print) (SCM exp, SCM port, scm_print_state *pstate);
   SCM (*equalp) (SCM, SCM);
-  SCM (*apply) ();
-  SCM (*apply_0) (SCM);
-  SCM (*apply_1) (SCM, SCM);
-  SCM (*apply_2) (SCM, SCM, SCM);
-  SCM (*apply_3) (SCM, SCM, SCM, SCM);
-  int gsubr_type; /* Used in procprop.c */
+  scm_t_subr apply;
+  SCM apply_trampoline_objcode;
 } scm_smob_descriptor;
 
 
@@ -51,18 +52,25 @@ SCM_API SCM scm_i_new_smob_with_mark_proc (scm_t_bits tc,
 
 
 
-#define SCM_NEWSMOB(z, tc, data)                                       \
-do                                                                     \
-  {                                                                    \
-    register scm_t_bits _smobnum = SCM_TC2SMOBNUM (tc);                        \
-    z = (scm_smobs[_smobnum].mark                                      \
-        ? scm_i_new_smob_with_mark_proc ((tc), (scm_t_bits)(data),     \
-                                         0, 0)                         \
-        : scm_cell (tc, (scm_t_bits)(data)));                          \
-    if (scm_smobs[_smobnum].free)                                      \
-      scm_gc_register_finalizer ((z), scm_i_finalize_smob,             \
-                                SCM_BOOL_F, 0);                        \
-  }                                                                    \
+#define SCM_NEWSMOB(z, tc, data)                                         \
+do                                                                       \
+  {                                                                      \
+    register scm_t_bits _smobnum = SCM_TC2SMOBNUM (tc);                          \
+    z = (scm_smobs[_smobnum].mark                                        \
+        ? scm_i_new_smob_with_mark_proc ((tc), (scm_t_bits)(data),       \
+                                         0, 0)                           \
+        : scm_cell (tc, (scm_t_bits)(data)));                            \
+    if (scm_smobs[_smobnum].free)                                        \
+      {                                                                          \
+       GC_finalization_proc _prev_finalizer;                             \
+       GC_PTR _prev_finalizer_data;                                      \
+                                                                         \
+       GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (z), scm_i_finalize_smob, \
+                                       NULL,                             \
+                                       &_prev_finalizer,                 \
+                                       &_prev_finalizer_data);           \
+      }                                                                          \
+  }                                                                      \
 while (0)
 
 #define SCM_RETURN_NEWSMOB(tc, data)                   \
@@ -80,21 +88,28 @@ while (0)
        return __SCM_smob_answer;                                       \
   } while (0)
 
-#define SCM_NEWSMOB3(z, tc, data1, data2, data3)                       \
-do                                                                     \
-  {                                                                    \
-    register scm_t_bits _smobnum = SCM_TC2SMOBNUM (tc);                        \
-    z = (scm_smobs[_smobnum].mark                                      \
-        ? scm_i_new_smob_with_mark_proc (tc, (scm_t_bits)(data1),      \
-                                         (scm_t_bits)(data2),          \
-                                         (scm_t_bits)(data3))          \
-        : scm_double_cell ((tc), (scm_t_bits)(data1),                  \
-                           (scm_t_bits)(data2),                        \
-                           (scm_t_bits)(data3)));                      \
-    if (scm_smobs[_smobnum].free)                                      \
-      scm_gc_register_finalizer ((z), scm_i_finalize_smob,             \
-                                SCM_BOOL_F, 0);                        \
-  }                                                                    \
+#define SCM_NEWSMOB3(z, tc, data1, data2, data3)                         \
+do                                                                       \
+  {                                                                      \
+    register scm_t_bits _smobnum = SCM_TC2SMOBNUM (tc);                          \
+    z = (scm_smobs[_smobnum].mark                                        \
+        ? scm_i_new_smob_with_mark_proc (tc, (scm_t_bits)(data1),        \
+                                         (scm_t_bits)(data2),            \
+                                         (scm_t_bits)(data3))            \
+        : scm_double_cell ((tc), (scm_t_bits)(data1),                    \
+                           (scm_t_bits)(data2),                          \
+                           (scm_t_bits)(data3)));                        \
+    if (scm_smobs[_smobnum].free)                                        \
+      {                                                                          \
+       GC_finalization_proc _prev_finalizer;                             \
+       GC_PTR _prev_finalizer_data;                                      \
+                                                                         \
+       GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (z), scm_i_finalize_smob, \
+                                       NULL,                             \
+                                       &_prev_finalizer,                 \
+                                       &_prev_finalizer_data);           \
+      }                                                                          \
+  }                                                                      \
 while (0)
 
 #define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3)                       \
@@ -104,25 +119,47 @@ while (0)
   } while (0)
 
 
-#define SCM_SMOB_FLAGS(x)               (SCM_CELL_WORD_0 (x) >> 16)
-#define SCM_SMOB_DATA(x)               (SCM_CELL_WORD_1 (x))
-#define SCM_SMOB_DATA_2(x)             (SCM_CELL_WORD_2 (x))
-#define SCM_SMOB_DATA_3(x)             (SCM_CELL_WORD_3 (x))
-#define SCM_SET_SMOB_DATA(x, data)     (SCM_SET_CELL_WORD_1 ((x), (data)))
-#define SCM_SET_SMOB_DATA_2(x, data)   (SCM_SET_CELL_WORD_2 ((x), (data)))
-#define SCM_SET_SMOB_DATA_3(x, data)   (SCM_SET_CELL_WORD_3 ((x), (data)))
-#define SCM_SET_SMOB_FLAGS(x, data)     (scm_i_set_smob_flags((x),(data)<<16))
-
-#define SCM_SMOB_OBJECT(x)             (SCM_CELL_OBJECT_1 (x))
-#define SCM_SMOB_OBJECT_2(x)           (SCM_CELL_OBJECT_2 (x))
-#define SCM_SMOB_OBJECT_3(x)           (SCM_CELL_OBJECT_3 (x))
-#define SCM_SET_SMOB_OBJECT(x,obj)     (SCM_SET_CELL_OBJECT_1 ((x), (obj)))
-#define SCM_SET_SMOB_OBJECT_2(x,obj)    (SCM_SET_CELL_OBJECT_2 ((x), (obj)))
-#define SCM_SET_SMOB_OBJECT_3(x,obj)    (SCM_SET_CELL_OBJECT_3 ((x), (obj)))
-#define SCM_SMOB_OBJECT_LOC(x)         (SCM_CELL_OBJECT_LOC ((x), 1))
-#define SCM_SMOB_OBJECT_2_LOC(x)       (SCM_CELL_OBJECT_LOC ((x), 2))
-#define SCM_SMOB_OBJECT_3_LOC(x)       (SCM_CELL_OBJECT_LOC ((x), 3))
-
+#define SCM_SMOB_DATA_N(x, n)          (SCM_CELL_WORD ((x), (n)))
+#define SCM_SET_SMOB_DATA_N(x, n, data)        (SCM_SET_CELL_WORD ((x), (n), (data)))
+
+#define SCM_SMOB_DATA_0(x)             (SCM_SMOB_DATA_N ((x), 0))
+#define SCM_SMOB_DATA_1(x)             (SCM_SMOB_DATA_N ((x), 1))
+#define SCM_SMOB_DATA_2(x)             (SCM_SMOB_DATA_N ((x), 2))
+#define SCM_SMOB_DATA_3(x)             (SCM_SMOB_DATA_N ((x), 3))
+#define SCM_SET_SMOB_DATA_0(x, data)   (SCM_SET_SMOB_DATA_N ((x), 0, (data)))
+#define SCM_SET_SMOB_DATA_1(x, data)   (SCM_SET_SMOB_DATA_N ((x), 1, (data)))
+#define SCM_SET_SMOB_DATA_2(x, data)   (SCM_SET_SMOB_DATA_N ((x), 2, (data)))
+#define SCM_SET_SMOB_DATA_3(x, data)   (SCM_SET_SMOB_DATA_N ((x), 3, (data)))
+
+#define SCM_SMOB_FLAGS(x)               (SCM_SMOB_DATA_0 (x) >> 16)
+#define SCM_SMOB_DATA(x)               (SCM_SMOB_DATA_1 (x))
+#define SCM_SET_SMOB_FLAGS(x, data)     (SCM_SET_SMOB_DATA_0 ((x), (SCM_CELL_TYPE (x)&0xffff)|((data)<<16)))
+#define SCM_SET_SMOB_DATA(x, data)     (SCM_SET_SMOB_DATA_1 ((x), (data)))
+
+#define SCM_SMOB_OBJECT_N(x,n)         (SCM_CELL_OBJECT ((x), (n)))
+#define SCM_SET_SMOB_OBJECT_N(x,n,obj) (SCM_SET_CELL_OBJECT ((x), (n), (obj)))
+#define SCM_SMOB_OBJECT_N_LOC(x,n)     (SCM_CELL_OBJECT_LOC ((x), (n)))
+
+/*#define SCM_SMOB_OBJECT_0(x)         (SCM_SMOB_OBJECT_N ((x), 0))*/
+#define SCM_SMOB_OBJECT_1(x)           (SCM_SMOB_OBJECT_N ((x), 1))
+#define SCM_SMOB_OBJECT_2(x)           (SCM_SMOB_OBJECT_N ((x), 2))
+#define SCM_SMOB_OBJECT_3(x)           (SCM_SMOB_OBJECT_N ((x), 3))
+/*#define SCM_SET_SMOB_OBJECT_0(x,obj) (SCM_SET_SMOB_OBJECT_N ((x), 0, (obj)))*/
+#define SCM_SET_SMOB_OBJECT_1(x,obj)   (SCM_SET_SMOB_OBJECT_N ((x), 1, (obj)))
+#define SCM_SET_SMOB_OBJECT_2(x,obj)   (SCM_SET_SMOB_OBJECT_N ((x), 2, (obj)))
+#define SCM_SET_SMOB_OBJECT_3(x,obj)   (SCM_SET_SMOB_OBJECT_N ((x), 3, (obj)))
+#define SCM_SMOB_OBJECT_0_LOC(x)       (SCM_SMOB_OBJECT_N_LOC ((x), 0)))
+#define SCM_SMOB_OBJECT_1_LOC(x)       (SCM_SMOB_OBJECT_N_LOC ((x), 1)))
+#define SCM_SMOB_OBJECT_2_LOC(x)       (SCM_SMOB_OBJECT_N_LOC ((x), 2)))
+#define SCM_SMOB_OBJECT_3_LOC(x)       (SCM_SMOB_OBJECT_N_LOC ((x), 3)))
+
+#define SCM_SMOB_OBJECT(x)             (SCM_SMOB_OBJECT_1 (x))
+#define SCM_SET_SMOB_OBJECT(x,obj)     (SCM_SET_SMOB_OBJECT_1 ((x), (obj)))
+#define SCM_SMOB_OBJECT_LOC(x)         (SCM_SMOB_OBJECT_1_LOC (x)))
+
+
+#define SCM_SMOB_TYPE_MASK             0xffff
+#define SCM_SMOB_TYPE_BITS(tc)         (tc)
 #define SCM_TC2SMOBNUM(x)              (0x0ff & ((x) >> 8))
 #define SCM_SMOBNUM(x)                 (SCM_TC2SMOBNUM (SCM_CELL_TYPE (x)))
 /* SCM_SMOBNAME can be 0 if name is missing */
@@ -130,23 +167,24 @@ while (0)
 #define SCM_SMOB_PREDICATE(tag, obj)   SCM_TYP16_PREDICATE (tag, obj)
 #define SCM_SMOB_DESCRIPTOR(x)         (scm_smobs[SCM_SMOBNUM (x)])
 #define SCM_SMOB_APPLICABLE_P(x)       (SCM_SMOB_DESCRIPTOR (x).apply)
-#define SCM_SMOB_APPLY_0(x)            (SCM_SMOB_DESCRIPTOR (x).apply_0 (x))
-#define SCM_SMOB_APPLY_1(x, a1)                (SCM_SMOB_DESCRIPTOR (x).apply_1 (x, (a1)))
-#define SCM_SMOB_APPLY_2(x, a1, a2)    (SCM_SMOB_DESCRIPTOR (x).apply_2 (x, (a1), (a2)))
-#define SCM_SMOB_APPLY_3(x, a1, a2, rst)       (SCM_SMOB_DESCRIPTOR (x).apply_3 (x, (a1), (a2), (rst)))
+#define SCM_SMOB_APPLY_0(x)            (scm_call_0 (x))
+#define SCM_SMOB_APPLY_1(x, a1)                (scm_call_1 (x, a1))
+#define SCM_SMOB_APPLY_2(x, a1, a2)    (scm_call_2 (x, a1, a2))
+#define SCM_SMOB_APPLY_3(x, a1, a2, rst) (scm_call_3 (x, a1, a2, a3))
+
+/* Maximum number of SMOB types.  */
+#define SCM_I_MAX_SMOB_TYPE_COUNT  256
 
 SCM_API long scm_numsmob;
 SCM_API scm_smob_descriptor scm_smobs[];
 
-SCM_API void scm_i_set_smob_flags (SCM x, scm_t_bits data);
-SCM_API SCM scm_i_finalize_smob (SCM smob, SCM data);
+SCM_API void scm_i_finalize_smob (GC_PTR obj, GC_PTR data);
 
 \f
 
 SCM_API SCM scm_mark0 (SCM ptr);
 SCM_API SCM scm_markcdr (SCM ptr);
 SCM_API size_t scm_free0 (SCM ptr);
-SCM_API size_t scm_smob_free (SCM obj);
 SCM_API int scm_smob_print (SCM exp, SCM port, scm_print_state *pstate);
 
 /* The following set of functions is the standard way to create new
@@ -165,7 +203,7 @@ SCM_API void scm_set_smob_print (scm_t_bits tc,
                                 int (*print) (SCM, SCM, scm_print_state*));
 SCM_API void scm_set_smob_equalp (scm_t_bits tc, SCM (*equalp) (SCM, SCM));
 SCM_API void scm_set_smob_apply (scm_t_bits tc,
-                                SCM (*apply) (),
+                                scm_t_subr apply,
                                 unsigned int req,
                                 unsigned int opt,
                                 unsigned int rst);
@@ -176,6 +214,8 @@ SCM_API void scm_assert_smob_type (scm_t_bits tag, SCM val);
 
 SCM_API SCM scm_make_smob (scm_t_bits tc);
 
+SCM_INTERNAL SCM scm_i_smob_apply_trampoline (SCM smob);
+
 SCM_API void scm_smob_prehistory (void);
 
 #endif  /* SCM_SMOB_H */