Merge branch 'master' into boehm-demers-weiser-gc
[bpt/guile.git] / libguile / smob.h
dissimilarity index 91%
index 9785a87..2bf508e 100644 (file)
-/* classes: h_files */
-
-#ifndef SMOBH
-#define SMOBH
-/*     Copyright (C) 1995,1996,1998 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
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program 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 General Public License for more details.
- * 
- * 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, 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.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
- *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
- *
- * 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.  */
-\f
-#include "libguile/__scm.h"
-#include "libguile/print.h"
-
-\f
-typedef struct scm_smobfuns
-{
-  SCM (*mark) SCM_P ((SCM));
-  scm_sizet (*free) SCM_P ((SCM));
-  int (*print) SCM_P ((SCM exp, SCM port, scm_print_state *pstate));
-  SCM (*equalp) SCM_P ((SCM, SCM));
-} scm_smobfuns;
-
-\f
-
-#define SCM_SMOBNUM(x) (0x0ff & (SCM_CAR(x)>>8))
-
-extern int scm_numsmob;
-extern scm_smobfuns *scm_smobs;
-
-\f
-
-/* Everyone who uses smobs needs to print.  */
-#include "libguile/ports.h"
-#include "libguile/genio.h"
-
-/* ... and they all need to GC.  */
-#include "libguile/markers.h"
-
-\f
-extern long scm_newsmob SCM_P ((const scm_smobfuns *smob));
-extern void scm_smob_prehistory SCM_P ((void));
-
-#endif  /* SMOBH */
+/* classes: h_files */
+
+#ifndef SCM_SMOB_H
+#define SCM_SMOB_H
+
+/* 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
+ * License as published by the Free Software Foundation; either
+ * version 2.1 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
+ * 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
+ */
+
+\f
+
+#include "libguile/__scm.h"
+#include "libguile/print.h"
+
+#include "libguile/boehm-gc.h"
+
+
+\f
+/* This is the internal representation of a smob type */
+
+typedef struct scm_smob_descriptor
+{
+  char const *name;
+  size_t size;
+  SCM (*mark) (SCM);
+  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_smob_descriptor;
+
+
+\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)      \
+  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;                                       \
+  } 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)                                        \
+      {                                                                          \
+       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 */
+#define SCM_SMOBNAME(smobnum)          (scm_smobs[smobnum].name)
+#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)))
+
+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);
+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
+ * 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'.
+ */
+
+SCM_API scm_t_bits scm_make_smob_type (char const *name, size_t size);
+
+SCM_API void scm_set_smob_mark (scm_t_bits tc, SCM (*mark) (SCM));
+SCM_API void scm_set_smob_free (scm_t_bits tc, size_t (*free) (SCM));
+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) (),
+                                unsigned int req,
+                                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 */
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/