2002-07-20 Han-Wen <hanwen@cs.uu.nl>
[bpt/guile.git] / libguile / smob.h
index cf5712f..c1893a4 100644 (file)
@@ -1,22 +1,24 @@
 /* classes: h_files */
 
-#ifndef SMOBH
-#define SMOBH
-/*     Copyright (C) 1995,1996 Free Software Foundation, Inc.
- * 
+#ifndef SCM_SMOB_H
+#define SCM_SMOB_H
+
+/* Copyright (C) 1995,1996,1998,1999,2000,2001 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, 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 "libguile/__scm.h"
+#include "libguile/print.h"
 
 \f
-typedef struct scm_smobfuns
+/* This is the internal representation of a smob type */
+
+typedef struct scm_smob_descriptor
 {
-  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;
+  char *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
 
-#define SCM_SMOBNUM(x) (0x0ff & (SCM_CAR(x)>>8));
-#define SCM_PTOBNUM(x) (0x0ff & (SCM_CAR(x)>>8));
+#define SCM_NEWSMOB(z, tc, data) \
+do { \
+  z = scm_cell ((tc), (scm_t_bits) (data)); \
+} while (0)
 
-extern scm_sizet scm_numsmob;
-extern scm_smobfuns *scm_smobs;
+#define SCM_RETURN_NEWSMOB(tc, data) \
+  do { SCM __SCM_smob_answer; \
+       SCM_NEWSMOB (__SCM_smob_answer, (tc), (data)); \
+       return __SCM_smob_answer; \
+  } while (0)
 
-\f
+#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_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)
 
-/* Everyone who uses smobs needs to print.  */
-#include "libguile/ports.h"
-#include "libguile/genio.h"
+#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)
 
-/* ... and they all need to GC.  */
-#include "libguile/markers.h"
+
+#define SCM_SMOB_DATA(x)               (SCM_CELL_WORD_1 (x))
+#define SCM_SET_SMOB_DATA(x, data)     (SCM_SET_CELL_WORD_1 ((x), (data)))
+#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[];
 
 \f
-extern long scm_newsmob SCM_P ((scm_smobfuns *smob));
-extern void scm_smob_prehistory SCM_P ((void));
 
-#endif  /* SMOBH */
+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 *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);
+
+/* 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:
+*/