5 /* Copyright (C) 1995, 1996, 1998, 1999 Free Software Foundation, Inc.
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)
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.
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
22 * As a special exception, the Free Software Foundation gives permission
23 * for additional uses of the text contained in its release of GUILE.
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.
31 * This exception does not however invalidate any other reasons why
32 * the executable file might be covered by the GNU General Public License.
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.
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. */
46 #include "libguile/__scm.h"
47 #include "libguile/print.h"
50 /* This is the internal representation of a smob type */
52 typedef struct scm_smob_descriptor
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
;
62 /* scm_smobfuns is the argument type for the obsolete function scm_newsmob */
64 typedef struct scm_smobfuns
67 scm_sizet (*free
) (SCM
);
68 int (*print
) (SCM exp
, SCM port
, scm_print_state
*pstate
);
69 SCM (*equalp
) (SCM
, SCM
);
74 #define SCM_NEWSMOB(z, tc, data) \
77 SCM_SETCDR (z, data); \
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; \
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 & (SCM_UNPACK(x) >> 8))
91 #define SCM_SMOBNUM(x) (SCM_TC2SMOBNUM (SCM_CAR (x)))
92 /* SCM_SMOBNAME can be 0 if name is missing */
93 #define SCM_SMOBNAME(smobnum) scm_smobs[smobnum].name
95 extern int scm_numsmob
;
96 extern scm_smob_descriptor
*scm_smobs
;
100 extern SCM
scm_mark0 (SCM ptr
);
101 extern SCM
scm_markcdr (SCM ptr
);
102 extern scm_sizet
scm_free0 (SCM ptr
);
103 extern scm_sizet
scm_smob_free (SCM obj
);
104 extern int scm_smob_print (SCM exp
, SCM port
, scm_print_state
*pstate
);
106 /* These next two functions are the supported way to create new SMOB types.
108 scm_make_smob_type is useful if there are no special smob functions
109 and the defaults work for mark,free,print,equal_p, or you want to use
110 scm_set_smob_{mark,free,print,equalp}, below.
112 scm_make_smob_type_mfpe is ideal if you need to set one or more of
113 the special smob functions-- use NULL for when the default function
117 extern long scm_make_smob_type (char *name
, scm_sizet size
);
119 extern long scm_make_smob_type_mfpe (char *name
, scm_sizet size
,
121 scm_sizet (*free
) (SCM
),
122 int (*print
) (SCM
, SCM
, scm_print_state
*),
123 SCM (*equalp
) (SCM
, SCM
));
125 extern void scm_set_smob_mark (long tc
, SCM (*mark
) (SCM
));
126 extern void scm_set_smob_free (long tc
, scm_sizet (*free
) (SCM
));
127 extern void scm_set_smob_print (long tc
, int (*print
) (SCM
,
130 extern void scm_set_smob_equalp (long tc
, SCM (*equalp
) (SCM
, SCM
));
131 /* convenience function for registering multiple handler fns */
132 extern void scm_set_smob_mfpe (long tc
,
134 scm_sizet (*free
) (SCM
),
135 int (*print
) (SCM
, SCM
, scm_print_state
*),
136 SCM (*equalp
) (SCM
, SCM
));
139 extern SCM
scm_make_smob (long tc
);
140 extern void scm_smob_prehistory (void);
142 /* Deprecated function */
143 extern long scm_newsmob (const scm_smobfuns
*smob
);