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   SCM (*mark) (SCM);
  57   scm_sizet (*free) (SCM);
  58   int (*print) (SCM exp, SCM port, scm_print_state *pstate);
  59   SCM (*equalp) (SCM, SCM);
  60   SCM (*apply) ();
  61   int gsubr_type;
  62 } scm_smob_descriptor;
  63
  64 \f
  65
  66 #define SCM_NEWSMOB(z, tc, data) \
  67 do { \
  68   SCM_NEWCELL (z); \
  69   SCM_SET_CELL_WORD_1 ((z), (data)); \
  70   SCM_SET_CELL_TYPE ((z), (tc)); \
  71 } while (0)
  72
  73 #define SCM_RETURN_NEWSMOB(tc, data) \
  74   do { SCM __SCM_smob_answer; \
  75        SCM_NEWSMOB (__SCM_smob_answer, (tc), (data)); \
  76        return __SCM_smob_answer; \
  77   } while (0)
  78
  79 #define SCM_NEWSMOB2(z, tc, data1, data2) \
  80 do { \
  81   SCM_NEWCELL2 (z); \
  82   SCM_SET_CELL_WORD_1 ((z), (data1)); \
  83   SCM_SET_CELL_WORD_2 ((z), (data2)); \
  84   SCM_SET_CELL_TYPE ((z), (tc)); \
  85 } while (0)
  86
  87 #define SCM_RETURN_NEWSMOB2(tc, data1, data2) \
  88   do { SCM __SCM_smob_answer; \
  89        SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2)); \
  90        return __SCM_smob_answer; \
  91   } while (0)
  92
  93 #define SCM_NEWSMOB3(z, tc, data1, data2, data3) \
  94 do { \
  95   SCM_NEWCELL2 (z); \
  96   SCM_SET_CELL_WORD_1 ((z), (data1)); \
  97   SCM_SET_CELL_WORD_2 ((z), (data2)); \
  98   SCM_SET_CELL_WORD_3 ((z), (data3)); \
  99   SCM_SET_CELL_TYPE ((z), (tc)); \
 100 } while (0)
 101
 102 #define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3) \
 103   do { SCM __SCM_smob_answer; \
 104        SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3)); \
 105        return __SCM_smob_answer; \
 106   } while (0)
 107
 108
 109 #define SCM_SMOB_DATA(x)                (SCM_CELL_WORD_1 (x))
 110 #define SCM_SET_SMOB_DATA(x, data)      (SCM_SET_CELL_WORD_1 ((x), (data)))
 111 #define SCM_TC2SMOBNUM(x)               (0x0ff & ((x) >> 8))
 112 #define SCM_SMOBNUM(x)                  (SCM_TC2SMOBNUM (SCM_CELL_TYPE (x)))
 113 /* SCM_SMOBNAME can be 0 if name is missing */
 114 #define SCM_SMOBNAME(smobnum)           (scm_smobs[smobnum].name)
 115 #define SCM_SMOB_PREDICATE(tag, obj)    (SCM_NIMP (obj) \
 116                                          && SCM_TYP16 (obj) == (tag))
 117 #define SCM_SMOB_DESCRIPTOR(x)          (scm_smobs[SCM_SMOBNUM (x)])
 118
 119 extern int scm_numsmob;
 120 extern scm_smob_descriptor *scm_smobs;
 121
 122 \f
 123
 124 extern SCM scm_mark0 (SCM ptr);
 125 extern SCM scm_markcdr (SCM ptr);
 126 extern scm_sizet scm_free0 (SCM ptr);
 127 extern scm_sizet scm_smob_free (SCM obj);
 128 extern int scm_smob_print (SCM exp, SCM port, scm_print_state *pstate);
 129
 130 extern SCM scm_smob_apply_0 (SCM smob);
 131 extern SCM scm_smob_apply_1 (SCM smob, SCM a1);
 132 extern SCM scm_smob_apply_2 (SCM smob, SCM a1, SCM a2);
 133 extern SCM scm_smob_apply_3 (SCM smob, SCM a1, SCM a2, SCM rest);
 134
 135 /* The following set of functions is the standard way to create new
 136  * SMOB types.
 137  *
 138  * Create a type tag using `scm_make_smob_type', accept default values
 139  * for mark, free, print and/or equalp functions, or set your own
 140  * values using `scm_set_smob_xxx'.
 141  */
 142
 143 extern long scm_make_smob_type (char *name, scm_sizet size);
 144
 145 extern void scm_set_smob_mark (long tc, SCM (*mark) (SCM));
 146 extern void scm_set_smob_free (long tc, scm_sizet (*free) (SCM));
 147 extern void scm_set_smob_print (long tc, int (*print) (SCM,
 148                                                        SCM,
 149                                                        scm_print_state*));
 150 extern void scm_set_smob_equalp (long tc, SCM (*equalp) (SCM, SCM));
 151 extern void scm_set_smob_apply (long tc, SCM (*apply) (), int req, int opt, int rst);
 152
 153
 154 /* Functions for registering multiple handler functions simultaneously.
 155  *
 156  * (There is a discussion among the developers whether or not these
 157  *  should be deprecated in the future.)
 158  */
 159
 160 extern long scm_make_smob_type_mfpe (char *name, scm_sizet size,
 161                                     SCM (*mark) (SCM),
 162                                     scm_sizet (*free) (SCM),
 163                                     int (*print) (SCM, SCM, scm_print_state*),
 164                                     SCM (*equalp) (SCM, SCM));
 165
 166 extern void scm_set_smob_mfpe (long tc,
 167                                SCM (*mark) (SCM),
 168                                scm_sizet (*free) (SCM),
 169                                int (*print) (SCM, SCM, scm_print_state*),
 170                                SCM (*equalp) (SCM, SCM));
 171
 172 /* Function for creating smobs */
 173
 174 extern SCM scm_make_smob (long tc);
 175 extern void scm_smob_prehistory (void);
 176
 177 \f
 178
 179 #endif  /* SMOBH */
 180
 181 /*
 182   Local Variables:
 183   c-file-style: "gnu"
 184   End:
 185 */