libguile/smob.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_SMOB_H
   4 #define SCM_SMOB_H
   5
   6 /* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006, 2009 Free Software Foundation, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 3 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  */
  23
  24 \f
  25
  26 #include "libguile/__scm.h"
  27 #include "libguile/print.h"
  28
  29 \f
  30 /* This is the internal representation of a smob type */
  31
  32 typedef struct scm_smob_descriptor
  33 {
  34   char const *name;
  35   size_t size;
  36   SCM (*mark) (SCM);
  37   size_t (*free) (SCM);
  38   int (*print) (SCM exp, SCM port, scm_print_state *pstate);
  39   SCM (*equalp) (SCM, SCM);
  40   SCM (*apply) ();
  41   SCM (*apply_0) (SCM);
  42   SCM (*apply_1) (SCM, SCM);
  43   SCM (*apply_2) (SCM, SCM, SCM);
  44   SCM (*apply_3) (SCM, SCM, SCM, SCM);
  45   int gsubr_type; /* Used in procprop.c */
  46 } scm_smob_descriptor;
  47
  48 \f
  49
  50 #define SCM_NEWSMOB(z, tc, data) \
  51 do { \
  52   z = scm_cell ((tc), (scm_t_bits) (data)); \
  53 } while (0)
  54
  55 #define SCM_RETURN_NEWSMOB(tc, data) \
  56   do { SCM __SCM_smob_answer; \
  57        SCM_NEWSMOB (__SCM_smob_answer, (tc), (data)); \
  58        return __SCM_smob_answer; \
  59   } while (0)
  60
  61 #define SCM_NEWSMOB2(z, tc, data1, data2) \
  62 do { \
  63   z = scm_double_cell ((tc), (scm_t_bits)(data1), (scm_t_bits)(data2), 0); \
  64 } while (0)
  65
  66 #define SCM_RETURN_NEWSMOB2(tc, data1, data2) \
  67   do { SCM __SCM_smob_answer; \
  68        SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2)); \
  69        return __SCM_smob_answer; \
  70   } while (0)
  71
  72 #define SCM_NEWSMOB3(z, tc, data1, data2, data3) \
  73 do { \
  74   z = scm_double_cell ((tc), (scm_t_bits)(data1), \
  75                        (scm_t_bits)(data2), (scm_t_bits)(data3)); \
  76 } while (0)
  77
  78 #define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3) \
  79   do { SCM __SCM_smob_answer; \
  80        SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3)); \
  81        return __SCM_smob_answer; \
  82   } while (0)
  83
  84
  85 #define SCM_SMOB_FLAGS(x)               (SCM_CELL_WORD_0 (x) >> 16)
  86 #define SCM_SMOB_DATA(x)                (SCM_CELL_WORD_1 (x))
  87 #define SCM_SMOB_DATA_2(x)              (SCM_CELL_WORD_2 (x))
  88 #define SCM_SMOB_DATA_3(x)              (SCM_CELL_WORD_3 (x))
  89 #define SCM_SET_SMOB_DATA(x, data)      (SCM_SET_CELL_WORD_1 ((x), (data)))
  90 #define SCM_SET_SMOB_DATA_2(x, data)    (SCM_SET_CELL_WORD_2 ((x), (data)))
  91 #define SCM_SET_SMOB_DATA_3(x, data)    (SCM_SET_CELL_WORD_3 ((x), (data)))
  92 #define SCM_SET_SMOB_FLAGS(x, data)     (scm_i_set_smob_flags((x),(data)<<16))
  93
  94 #define SCM_SMOB_OBJECT(x)              (SCM_CELL_OBJECT_1 (x))
  95 #define SCM_SMOB_OBJECT_2(x)            (SCM_CELL_OBJECT_2 (x))
  96 #define SCM_SMOB_OBJECT_3(x)            (SCM_CELL_OBJECT_3 (x))
  97 #define SCM_SET_SMOB_OBJECT(x,obj)      (SCM_SET_CELL_OBJECT_1 ((x), (obj)))
  98 #define SCM_SET_SMOB_OBJECT_2(x,obj)    (SCM_SET_CELL_OBJECT_2 ((x), (obj)))
  99 #define SCM_SET_SMOB_OBJECT_3(x,obj)    (SCM_SET_CELL_OBJECT_3 ((x), (obj)))
 100 #define SCM_SMOB_OBJECT_LOC(x)          (SCM_CELL_OBJECT_LOC ((x), 1))
 101 #define SCM_SMOB_OBJECT_2_LOC(x)        (SCM_CELL_OBJECT_LOC ((x), 2))
 102 #define SCM_SMOB_OBJECT_3_LOC(x)        (SCM_CELL_OBJECT_LOC ((x), 3))
 103
 104 #define SCM_TC2SMOBNUM(x)               (0x0ff & ((x) >> 8))
 105 #define SCM_SMOBNUM(x)                  (SCM_TC2SMOBNUM (SCM_CELL_TYPE (x)))
 106 /* SCM_SMOBNAME can be 0 if name is missing */
 107 #define SCM_SMOBNAME(smobnum)           (scm_smobs[smobnum].name)
 108 #define SCM_SMOB_PREDICATE(tag, obj)    SCM_TYP16_PREDICATE (tag, obj)
 109 #define SCM_SMOB_DESCRIPTOR(x)          (scm_smobs[SCM_SMOBNUM (x)])
 110 #define SCM_SMOB_APPLICABLE_P(x)        (SCM_SMOB_DESCRIPTOR (x).apply)
 111 #define SCM_SMOB_APPLY_0(x)             (SCM_SMOB_DESCRIPTOR (x).apply_0 (x))
 112 #define SCM_SMOB_APPLY_1(x, a1)         (SCM_SMOB_DESCRIPTOR (x).apply_1 (x, (a1)))
 113 #define SCM_SMOB_APPLY_2(x, a1, a2)     (SCM_SMOB_DESCRIPTOR (x).apply_2 (x, (a1), (a2)))
 114 #define SCM_SMOB_APPLY_3(x, a1, a2, rst)        (SCM_SMOB_DESCRIPTOR (x).apply_3 (x, (a1), (a2), (rst)))
 115
 116 /* Maximum number of SMOB types.  */
 117 #define SCM_I_MAX_SMOB_TYPE_COUNT  256
 118
 119 SCM_API long scm_numsmob;
 120 SCM_API scm_smob_descriptor scm_smobs[];
 121
 122 SCM_API void scm_i_set_smob_flags (SCM x, scm_t_bits data);
 123
 124 \f
 125
 126 SCM_API SCM scm_mark0 (SCM ptr);
 127 SCM_API SCM scm_markcdr (SCM ptr);
 128 SCM_API size_t scm_free0 (SCM ptr);
 129 SCM_API size_t scm_smob_free (SCM obj);
 130 SCM_API int scm_smob_print (SCM exp, SCM port, scm_print_state *pstate);
 131
 132 /* The following set of functions is the standard way to create new
 133  * SMOB types.
 134  *
 135  * Create a type tag using `scm_make_smob_type', accept default values
 136  * for mark, free, print and/or equalp functions, or set your own
 137  * values using `scm_set_smob_xxx'.
 138  */
 139
 140 SCM_API scm_t_bits scm_make_smob_type (char const *name, size_t size);
 141
 142 SCM_API void scm_set_smob_mark (scm_t_bits tc, SCM (*mark) (SCM));
 143 SCM_API void scm_set_smob_free (scm_t_bits tc, size_t (*free) (SCM));
 144 SCM_API void scm_set_smob_print (scm_t_bits tc,
 145                                  int (*print) (SCM, SCM, scm_print_state*));
 146 SCM_API void scm_set_smob_equalp (scm_t_bits tc, SCM (*equalp) (SCM, SCM));
 147 SCM_API void scm_set_smob_apply (scm_t_bits tc,
 148                                  SCM (*apply) (),
 149                                  unsigned int req,
 150                                  unsigned int opt,
 151                                  unsigned int rst);
 152
 153 SCM_API void scm_assert_smob_type (scm_t_bits tag, SCM val);
 154
 155 /* Function for creating smobs */
 156
 157 SCM_API SCM scm_make_smob (scm_t_bits tc);
 158
 159 SCM_API void scm_smob_prehistory (void);
 160
 161 #endif  /* SCM_SMOB_H */
 162
 163 /*
 164   Local Variables:
 165   c-file-style: "gnu"
 166   End:
 167 */