Merge branch 'master' into boehm-demers-weiser-gc
[bpt/guile.git] / libguile / smob.h
index 97af67a..2bf508e 100644 (file)
@@ -3,7 +3,7 @@
 #ifndef SCM_SMOB_H
 #define SCM_SMOB_H
 
-/* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006 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
@@ -17,7 +17,7 @@
  *
  * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 \f
@@ -25,6 +25,9 @@
 #include "libguile/__scm.h"
 #include "libguile/print.h"
 
+#include "libguile/boehm-gc.h"
+
+
 \f
 /* This is the internal representation of a smob type */
 
@@ -44,45 +47,99 @@ typedef struct scm_smob_descriptor
   int gsubr_type; /* Used in procprop.c */
 } scm_smob_descriptor;
 
-\f
 
-#define SCM_NEWSMOB(z, tc, data) \
-do { \
-  z = scm_cell ((tc), (scm_t_bits) (data)); \
-} while (0)
-
-#define SCM_RETURN_NEWSMOB(tc, data) \
-  do { SCM __SCM_smob_answer; \
-       SCM_NEWSMOB (__SCM_smob_answer, (tc), (data)); \
-       return __SCM_smob_answer; \
+\f
+SCM_API SCM scm_i_new_smob_with_mark_proc (scm_t_bits tc,
+                                          scm_t_bits, scm_t_bits, scm_t_bits);
+
+
+
+#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)                   \
+  do { SCM __SCM_smob_answer;                          \
+       SCM_NEWSMOB (__SCM_smob_answer, (tc), (data));  \
+       return __SCM_smob_answer;                       \
   } while (0)
 
-#define SCM_NEWSMOB2(z, tc, data1, data2) \
-do { \
-  z = scm_double_cell ((tc), (scm_t_bits)(data1), (scm_t_bits)(data2), 0); \
-} while (0)
+#define SCM_NEWSMOB2(z, tc, data1, data2)      \
+  SCM_NEWSMOB3 (z, tc, data1, data2, 0)
 
-#define SCM_RETURN_NEWSMOB2(tc, data1, data2) \
-  do { SCM __SCM_smob_answer; \
-       SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2)); \
-       return __SCM_smob_answer; \
+#define SCM_RETURN_NEWSMOB2(tc, data1, data2)                          \
+  do { SCM __SCM_smob_answer;                                          \
+       SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2));       \
+       return __SCM_smob_answer;                                       \
   } while (0)
 
-#define SCM_NEWSMOB3(z, tc, data1, data2, data3) \
-do { \
-  z = scm_double_cell ((tc), (scm_t_bits)(data1), \
-                       (scm_t_bits)(data2), (scm_t_bits)(data3)); \
-} while (0)
-
-#define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3) \
-  do { SCM __SCM_smob_answer; \
-       SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3)); \
-       return __SCM_smob_answer; \
+#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)                       \
+  do { SCM __SCM_smob_answer;                                              \
+       SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3));   \
+       return __SCM_smob_answer;                                           \
   } 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_TC2SMOBNUM(x)              (0x0ff & ((x) >> 8))
 #define SCM_SMOBNUM(x)                 (SCM_TC2SMOBNUM (SCM_CELL_TYPE (x)))
 /* SCM_SMOBNAME can be 0 if name is missing */
@@ -98,6 +155,9 @@ do { \
 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 void scm_i_finalize_smob (GC_PTR obj, GC_PTR data);
+
 \f
 
 SCM_API SCM scm_mark0 (SCM ptr);
@@ -127,9 +187,12 @@ SCM_API void scm_set_smob_apply (scm_t_bits tc,
                                 unsigned int opt,
                                 unsigned int rst);
 
+SCM_API void scm_assert_smob_type (scm_t_bits tag, SCM val);
+
 /* Function for creating smobs */
 
 SCM_API SCM scm_make_smob (scm_t_bits tc);
+
 SCM_API void scm_smob_prehistory (void);
 
 #endif  /* SCM_SMOB_H */