libguile/smob.h

   1 /* classes: h_files */
   2
   3 #ifndef SMOBH
   4 #define SMOBH
   5 /*      Copyright (C) 1995, 1996, 1998, 1999, 2000 Free Software Foundation, Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2, or (at your option)
  10  * any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this software; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20  * Boston, MA 02111-1307 USA
  21  *
  22  * As a special exception, the Free Software Foundation gives permission
  23  * for additional uses of the text contained in its release of GUILE.
  24  *
  25  * The exception is that, if you link the GUILE library with other files
  26  * to produce an executable, this does not by itself cause the
  27  * resulting executable to be covered by the GNU General Public License.
  28  * Your use of that executable is in no way restricted on account of
  29  * linking the GUILE library code into it.
  30  *
  31  * This exception does not however invalidate any other reasons why
  32  * the executable file might be covered by the GNU General Public License.
  33  *
  34  * This exception applies only to the code released by the
  35  * Free Software Foundation under the name GUILE.  If you copy
  36  * code from other Free Software Foundation releases into a copy of
  37  * GUILE, as the General Public License permits, the exception does
  38  * not apply to the code that you add in this way.  To avoid misleading
  39  * anyone as to the status of such modified files, you must delete
  40  * this exception notice from them.
  41  *
  42  * If you write modifications of your own for GUILE, it is your choice
  43  * whether to permit this exception to apply to your modifications.
  44  * If you do not wish that, delete this exception notice.  */
  45 \f
  46 #include "libguile/__scm.h"
  47 #include "libguile/print.h"
  48
  49 \f
  50 /* This is the internal representation of a smob type */
  51
  52 typedef struct scm_smob_descriptor
  53 {
  54   char *name;
  55   scm_sizet size;
  56
  57   /* Basic functions */
  58   SCM (*mark) (SCM);
  59   scm_sizet (*free) (SCM);
  60   int (*print) (SCM exp, SCM port, scm_print_state *pstate);
  61   SCM (*equalp) (SCM, SCM);
  62
  63   /* Apply functions */
  64   SCM (*apply) ();
  65   SCM (*apply_0) (SCM);
  66   SCM (*apply_1) (SCM, SCM);
  67   SCM (*apply_2) (SCM, SCM, SCM);
  68   SCM (*apply_3) (SCM, SCM, SCM, SCM);
  69   int gsubr_type; /* Used in procprop.c */
  70
  71   /* Dump functions */
  72   SCM (*dump_mark) (SCM, SCM);
  73   void (*dump_dealloc) (SCM, SCM);
  74   void (*dump_store) (SCM, SCM);
  75   SCM (*undump_alloc) (SCM);
  76   void (*undump_restore) (SCM, SCM);
  77   void (*undump_init) (SCM);
  78 } scm_smob_descriptor;
  79
  80 \f
  81
  82 #define SCM_NEWSMOB(z, tc, data) \
  83 do { \
  84   SCM_NEWCELL (z); \
  85   SCM_SET_CELL_WORD_1 ((z), (data)); \
  86   SCM_SET_CELL_TYPE ((z), (tc)); \
  87 } while (0)
  88
  89 #define SCM_RETURN_NEWSMOB(tc, data) \
  90   do { SCM __SCM_smob_answer; \
  91        SCM_NEWSMOB (__SCM_smob_answer, (tc), (data)); \
  92        return __SCM_smob_answer; \
  93   } while (0)
  94
  95 #define SCM_NEWSMOB2(z, tc, data1, data2) \
  96 do { \
  97   SCM_NEWCELL2 (z); \
  98   SCM_SET_CELL_WORD_1 ((z), (data1)); \
  99   SCM_SET_CELL_WORD_2 ((z), (data2)); \
 100   SCM_SET_CELL_TYPE ((z), (tc)); \
 101 } while (0)
 102
 103 #define SCM_RETURN_NEWSMOB2(tc, data1, data2) \
 104   do { SCM __SCM_smob_answer; \
 105        SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2)); \
 106        return __SCM_smob_answer; \
 107   } while (0)
 108
 109 #define SCM_NEWSMOB3(z, tc, data1, data2, data3) \
 110 do { \
 111   SCM_NEWCELL2 (z); \
 112   SCM_SET_CELL_WORD_1 ((z), (data1)); \
 113   SCM_SET_CELL_WORD_2 ((z), (data2)); \
 114   SCM_SET_CELL_WORD_3 ((z), (data3)); \
 115   SCM_SET_CELL_TYPE ((z), (tc)); \
 116 } while (0)
 117
 118 #define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3) \
 119   do { SCM __SCM_smob_answer; \
 120        SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3)); \
 121        return __SCM_smob_answer; \
 122   } while (0)
 123
 124
 125 #define SCM_SMOB_DATA(x)                (SCM_CELL_WORD_1 (x))
 126 #define SCM_SET_SMOB_DATA(x, data)      (SCM_SET_CELL_WORD_1 ((x), (data)))
 127 #define SCM_TC2SMOBNUM(x)               (0x0ff & ((x) >> 8))
 128 #define SCM_SMOBNUM(x)                  (SCM_TC2SMOBNUM (SCM_CELL_TYPE (x)))
 129 /* SCM_SMOBNAME can be 0 if name is missing */
 130 #define SCM_SMOBNAME(smobnum)           (scm_smobs[smobnum].name)
 131 #define SCM_SMOB_PREDICATE(tag, obj)    SCM_TYP16_PREDICATE (tag, obj)
 132 #define SCM_SMOB_DESCRIPTOR(x)          (scm_smobs[SCM_SMOBNUM (x)])
 133 #define SCM_SMOB_APPLICABLE_P(x)        (SCM_SMOB_DESCRIPTOR (x).apply)
 134 #define SCM_SMOB_APPLY_0(x)             (SCM_SMOB_DESCRIPTOR (x).apply_0 (x))
 135 #define SCM_SMOB_APPLY_1(x,a1)          (SCM_SMOB_DESCRIPTOR (x).apply_1 (x, (a1)))
 136 #define SCM_SMOB_APPLY_2(x,a1,a2)       (SCM_SMOB_DESCRIPTOR (x).apply_2 (x, (a1), (a2)))
 137 #define SCM_SMOB_APPLY_3(x,a1,a2,rst)   (SCM_SMOB_DESCRIPTOR (x).apply_3 (x, (a1), (a2), (rst)))
 138
 139 extern int scm_numsmob;
 140 extern scm_smob_descriptor *scm_smobs;
 141
 142 \f
 143
 144 extern SCM scm_mark0 (SCM ptr);
 145 extern SCM scm_markcdr (SCM ptr);
 146 extern scm_sizet scm_free0 (SCM ptr);
 147 extern scm_sizet scm_smob_free (SCM obj);
 148 extern int scm_smob_print (SCM exp, SCM port, scm_print_state *pstate);
 149
 150 /* The following set of functions is the standard way to create new
 151  * SMOB types.
 152  *
 153  * Create a type tag using `scm_make_smob_type', accept default values
 154  * for mark, free, print and/or equalp functions, or set your own
 155  * values using `scm_set_smob_xxx'.
 156  */
 157
 158 extern scm_bits_t scm_make_smob_type (char *name, scm_sizet size);
 159
 160 extern void scm_set_smob_mark (scm_bits_t tc,
 161                                SCM (*mark) (SCM));
 162 extern void scm_set_smob_free (scm_bits_t tc,
 163                                scm_sizet (*free) (SCM));
 164 extern void scm_set_smob_print (scm_bits_t tc,
 165                                 int (*print) (SCM, SCM, scm_print_state*));
 166 extern void scm_set_smob_equalp (scm_bits_t tc,
 167                                  SCM (*equalp) (SCM, SCM));
 168 extern void scm_set_smob_apply (scm_bits_t tc,
 169                                 SCM (*apply) (),
 170                                 unsigned int req,
 171                                 unsigned int opt,
 172                                 unsigned int rst);
 173 extern void scm_set_smob_dump (scm_bits_t tc,
 174                                SCM (*mark) (SCM, SCM),
 175                                void (*dealloc) (SCM, SCM),
 176                                void (*store) (SCM, SCM));
 177 extern void scm_set_smob_undump (scm_bits_t tc,
 178                                  SCM (*alloc) (SCM),
 179                                  void (*restore) (SCM, SCM),
 180                                  void (*init) (SCM));
 181
 182 /* Function for creating smobs */
 183
 184 extern SCM scm_make_smob (scm_bits_t tc);
 185 extern void scm_smob_prehistory (void);
 186
 187 \f
 188
 189 #if (SCM_DEBUG_DEPRECATED == 0)
 190
 191 extern long scm_make_smob_type_mfpe (char *name, scm_sizet size,
 192                                     SCM (*mark) (SCM),
 193                                     scm_sizet (*free) (SCM),
 194                                     int (*print) (SCM, SCM, scm_print_state*),
 195                                     SCM (*equalp) (SCM, SCM));
 196
 197 extern void scm_set_smob_mfpe (long tc,
 198                                SCM (*mark) (SCM),
 199                                scm_sizet (*free) (SCM),
 200                                int (*print) (SCM, SCM, scm_print_state*),
 201                                SCM (*equalp) (SCM, SCM));
 202
 203 #endif  /* SCM_DEBUG_DEPRECATED == 0 */
 204
 205 #endif  /* SMOBH */
 206
 207 /*
 208   Local Variables:
 209   c-file-style: "gnu"
 210   End:
 211 */