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