libguile/smob.h

   1 /* classes: h_files */
   2
   3 #ifndef SMOBH
   4 #define SMOBH
   5 /*      Copyright (C) 1995,1996,1998 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_P ((SCM));
  57   scm_sizet (*free) SCM_P ((SCM));
  58   int (*print) SCM_P ((SCM exp, SCM port, scm_print_state *pstate));
  59   SCM (*equalp) SCM_P ((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_P ((SCM));
  67   scm_sizet (*free) SCM_P ((SCM));
  68   int (*print) SCM_P ((SCM exp, SCM port, scm_print_state *pstate));
  69   SCM (*equalp) SCM_P ((SCM, SCM));
  70 } scm_smobfuns;
  71
  72 \f
  73
  74 #define SCM_NEWSMOB(z, tc, data) \
  75 do { \
  76   SCM_NEWCELL (z); \
  77   SCM_SETCDR (z, data); \
  78   SCM_SETCAR (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
  88 #define SCM_SMOB_DATA(x) SCM_CDR (x)
  89 #define SCM_SET_SMOB_DATA(x, data) SCM_SETCDR (x, data)
  90 #define SCM_TC2SMOBNUM(x) (0x0ff & ((x) >> 8))
  91 #define SCM_SMOBNUM(x) (SCM_TC2SMOBNUM (SCM_CAR (x)))
  92 #define SCM_SMOBNAME(smobnum) scm_smobs[smobnum].name
  93
  94 extern int scm_numsmob;
  95 extern scm_smob_descriptor *scm_smobs;
  96
  97 \f
  98
  99 extern SCM scm_mark0 SCM_P ((SCM ptr));
 100 extern SCM scm_markcdr SCM_P ((SCM ptr));
 101 extern scm_sizet scm_free0 SCM_P ((SCM ptr));
 102 extern scm_sizet scm_smob_free (SCM obj);
 103 extern int scm_smob_print (SCM exp, SCM port, scm_print_state *pstate);
 104
 105 /* These next two functions are the supported way to create new SMOB types.
 106
 107    scm_make_smob_type is useful if there are no special smob functions
 108      and the defaults work for mark,free,print,equal_p, or you want to use
 109      scm_set_smob_{mark,free,print,equalp}, below.
 110
 111    scm_make_smob_type_mfpe is ideal if you need to set one or more of
 112      the special smob functions-- use NULL for when the default function
 113      is fine
 114 */
 115
 116 extern long scm_make_smob_type (char *name, scm_sizet size);
 117
 118 extern long scm_make_smob_type_mfpe (char *name, scm_sizet size,
 119                                     SCM (*mark) (SCM),
 120                                     scm_sizet (*free) (SCM),
 121                                     int (*print) (SCM, SCM, scm_print_state*),
 122                                     SCM (*equalp) (SCM, SCM));
 123
 124 extern void scm_set_smob_mark (long tc, SCM (*mark) (SCM));
 125 extern void scm_set_smob_free (long tc, scm_sizet (*free) (SCM));
 126 extern void scm_set_smob_print (long tc, int (*print) (SCM,
 127                                                        SCM,
 128                                                        scm_print_state*));
 129 extern void scm_set_smob_equalp (long tc, SCM (*equalp) (SCM, SCM));
 130 /* convenience function for registering multiple handler fns */
 131 extern void scm_set_smob_mfpe (long tc,
 132                                SCM (*mark) (SCM),
 133                                scm_sizet (*free) (SCM),
 134                                int (*print) (SCM, SCM, scm_print_state*),
 135                                SCM (*equalp) (SCM, SCM));
 136
 137
 138 extern SCM scm_make_smob (long tc);
 139 extern void scm_smob_prehistory (void);
 140
 141 /* Deprecated function */
 142 extern long scm_newsmob (const scm_smobfuns *smob);
 143
 144 #endif  /* SMOBH */