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_smob_descriptor;
  61
  62 /* scm_smobfuns is the argument type for the obsolete function scm_newsmob */
  63
  64 typedef struct scm_smobfuns
  65 {
  66   SCM (*mark) (SCM);
  67   scm_sizet (*free) (SCM);
  68   int (*print) (SCM exp, SCM port, scm_print_state *pstate);
  69   SCM (*equalp) (SCM, SCM);
  70 } scm_smobfuns;
  71
  72 \f
  73
  74 #define SCM_NEWSMOB(z, tc, data) \
  75 do { \
  76   SCM_NEWCELL (z); \
  77   SCM_SET_CELL_WORD_1 ((z), (data)); \
  78   SCM_SET_CELL_TYPE ((z), (tc)); \
  79 } while (0)
  80
  81 #define SCM_RETURN_NEWSMOB(tc, data) \
  82   do { SCM __SCM_smob_answer; \
  83        SCM_NEWSMOB (__SCM_smob_answer, (tc), (data)); \
  84        return __SCM_smob_answer; \
  85   } while (0)
  86
  87 #define SCM_NEWSMOB2(z, tc, data1, data2) \
  88 do { \
  89   SCM_NEWCELL2 (z); \
  90   SCM_SET_CELL_WORD_1 ((z), (data1)); \
  91   SCM_SET_CELL_WORD_2 ((z), (data2)); \
  92   SCM_SET_CELL_TYPE ((z), (tc)); \
  93 } while (0)
  94
  95 #define SCM_RETURN_NEWSMOB2(tc, data1, data2) \
  96   do { SCM __SCM_smob_answer; \
  97        SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2)); \
  98        return __SCM_smob_answer; \
  99   } while (0)
 100
 101 #define SCM_NEWSMOB3(z, tc, data1, data2, data3) \
 102 do { \
 103   SCM_NEWCELL2 (z); \
 104   SCM_SET_CELL_WORD_1 ((z), (data1)); \
 105   SCM_SET_CELL_WORD_2 ((z), (data2)); \
 106   SCM_SET_CELL_WORD_3 ((z), (data3)); \
 107   SCM_SET_CELL_TYPE ((z), (tc)); \
 108 } while (0)
 109
 110 #define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3) \
 111   do { SCM __SCM_smob_answer; \
 112        SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3)); \
 113        return __SCM_smob_answer; \
 114   } while (0)
 115
 116
 117 #define SCM_SMOB_DATA(x)                (SCM_CELL_WORD_1 (x))
 118 #define SCM_SET_SMOB_DATA(x, data)      (SCM_SET_CELL_WORD_1 ((x), (data)))
 119 #define SCM_TC2SMOBNUM(x)               (0x0ff & ((x) >> 8))
 120 #define SCM_SMOBNUM(x)                  (SCM_TC2SMOBNUM (SCM_CELL_TYPE (x)))
 121 /* SCM_SMOBNAME can be 0 if name is missing */
 122 #define SCM_SMOBNAME(smobnum)           (scm_smobs[smobnum].name)
 123 #define SCM_SMOB_PREDICATE(tag, obj)    (SCM_NIMP (obj) \
 124                                          && SCM_TYP16 (obj) == (tag))
 125
 126 extern int scm_numsmob;
 127 extern scm_smob_descriptor *scm_smobs;
 128
 129 \f
 130
 131 extern SCM scm_mark0 (SCM ptr);
 132 extern SCM scm_markcdr (SCM ptr);
 133 extern scm_sizet scm_free0 (SCM ptr);
 134 extern scm_sizet scm_smob_free (SCM obj);
 135 extern int scm_smob_print (SCM exp, SCM port, scm_print_state *pstate);
 136
 137 /* These next two functions are the supported way to create new SMOB types.
 138
 139    scm_make_smob_type is useful if there are no special smob functions
 140      and the defaults work for mark,free,print,equal_p, or you want to use
 141      scm_set_smob_{mark,free,print,equalp}, below.
 142
 143    scm_make_smob_type_mfpe is ideal if you need to set one or more of
 144      the special smob functions-- use NULL for when the default function
 145      is fine
 146 */
 147
 148 extern long scm_make_smob_type (char *name, scm_sizet size);
 149
 150 extern long scm_make_smob_type_mfpe (char *name, scm_sizet size,
 151                                     SCM (*mark) (SCM),
 152                                     scm_sizet (*free) (SCM),
 153                                     int (*print) (SCM, SCM, scm_print_state*),
 154                                     SCM (*equalp) (SCM, SCM));
 155
 156 extern void scm_set_smob_mark (long tc, SCM (*mark) (SCM));
 157 extern void scm_set_smob_free (long tc, scm_sizet (*free) (SCM));
 158 extern void scm_set_smob_print (long tc, int (*print) (SCM,
 159                                                        SCM,
 160                                                        scm_print_state*));
 161 extern void scm_set_smob_equalp (long tc, SCM (*equalp) (SCM, SCM));
 162 /* convenience function for registering multiple handler fns */
 163 extern void scm_set_smob_mfpe (long tc,
 164                                SCM (*mark) (SCM),
 165                                scm_sizet (*free) (SCM),
 166                                int (*print) (SCM, SCM, scm_print_state*),
 167                                SCM (*equalp) (SCM, SCM));
 168
 169
 170 extern SCM scm_make_smob (long tc);
 171 extern void scm_smob_prehistory (void);
 172
 173 /* Deprecated function */
 174 extern long scm_newsmob (const scm_smobfuns *smob);
 175
 176 #endif  /* SMOBH */
 177
 178 /*
 179   Local Variables:
 180   c-file-style: "gnu"
 181   End:
 182 */