5 /* Copyright (C) 1995, 1996, 1998, 1999, 2000 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
);
63 SCM (*apply_1
) (SCM
, SCM
);
64 SCM (*apply_2
) (SCM
, SCM
, SCM
);
65 SCM (*apply_3
) (SCM
, SCM
, SCM
, SCM
);
66 } scm_smob_descriptor
;
70 #define SCM_NEWSMOB(z, tc, data) \
73 SCM_SET_CELL_WORD_1 ((z), (data)); \
74 SCM_SET_CELL_TYPE ((z), (tc)); \
77 #define SCM_RETURN_NEWSMOB(tc, data) \
78 do { SCM __SCM_smob_answer; \
79 SCM_NEWSMOB (__SCM_smob_answer, (tc), (data)); \
80 return __SCM_smob_answer; \
83 #define SCM_NEWSMOB2(z, tc, data1, data2) \
86 SCM_SET_CELL_WORD_1 ((z), (data1)); \
87 SCM_SET_CELL_WORD_2 ((z), (data2)); \
88 SCM_SET_CELL_TYPE ((z), (tc)); \
91 #define SCM_RETURN_NEWSMOB2(tc, data1, data2) \
92 do { SCM __SCM_smob_answer; \
93 SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2)); \
94 return __SCM_smob_answer; \
97 #define SCM_NEWSMOB3(z, tc, data1, data2, data3) \
100 SCM_SET_CELL_WORD_1 ((z), (data1)); \
101 SCM_SET_CELL_WORD_2 ((z), (data2)); \
102 SCM_SET_CELL_WORD_3 ((z), (data3)); \
103 SCM_SET_CELL_TYPE ((z), (tc)); \
106 #define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3) \
107 do { SCM __SCM_smob_answer; \
108 SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3)); \
109 return __SCM_smob_answer; \
113 #define SCM_SMOB_DATA(x) (SCM_CELL_WORD_1 (x))
114 #define SCM_SET_SMOB_DATA(x, data) (SCM_SET_CELL_WORD_1 ((x), (data)))
115 #define SCM_TC2SMOBNUM(x) (0x0ff & ((x) >> 8))
116 #define SCM_SMOBNUM(x) (SCM_TC2SMOBNUM (SCM_CELL_TYPE (x)))
117 /* SCM_SMOBNAME can be 0 if name is missing */
118 #define SCM_SMOBNAME(smobnum) (scm_smobs[smobnum].name)
119 #define SCM_SMOB_PREDICATE(tag, obj) (SCM_NIMP (obj) \
120 && SCM_TYP16 (obj) == (tag))
121 #define SCM_SMOB_DESCRIPTOR(x) (scm_smobs[SCM_SMOBNUM (x)])
123 extern int scm_numsmob
;
124 extern scm_smob_descriptor
*scm_smobs
;
128 extern SCM
scm_mark0 (SCM ptr
);
129 extern SCM
scm_markcdr (SCM ptr
);
130 extern scm_sizet
scm_free0 (SCM ptr
);
131 extern scm_sizet
scm_smob_free (SCM obj
);
132 extern int scm_smob_print (SCM exp
, SCM port
, scm_print_state
*pstate
);
134 extern SCM
scm_smob_apply_0 (SCM smob
);
135 extern SCM
scm_smob_apply_1 (SCM smob
, SCM a1
);
136 extern SCM
scm_smob_apply_2 (SCM smob
, SCM a1
, SCM a2
);
137 extern SCM
scm_smob_apply_3 (SCM smob
, SCM a1
, SCM a2
, SCM rest
);
139 /* The following set of functions is the standard way to create new
142 * Create a type tag using `scm_make_smob_type', accept default values
143 * for mark, free, print and/or equalp functions, or set your own
144 * values using `scm_set_smob_xxx'.
147 extern long scm_make_smob_type (char *name
, scm_sizet size
);
149 extern void scm_set_smob_mark (long tc
, SCM (*mark
) (SCM
));
150 extern void scm_set_smob_free (long tc
, scm_sizet (*free
) (SCM
));
151 extern void scm_set_smob_print (long tc
, int (*print
) (SCM
,
154 extern void scm_set_smob_equalp (long tc
, SCM (*equalp
) (SCM
, SCM
));
155 extern void scm_set_smob_apply (long tc
, SCM (*apply
) (), int req
, int opt
, int rst
);
158 /* Functions for registering multiple handler functions simultaneously.
160 * (There is a discussion among the developers whether or not these
161 * should be deprecated in the future.)
164 extern long scm_make_smob_type_mfpe (char *name
, scm_sizet size
,
166 scm_sizet (*free
) (SCM
),
167 int (*print
) (SCM
, SCM
, scm_print_state
*),
168 SCM (*equalp
) (SCM
, SCM
));
170 extern void scm_set_smob_mfpe (long tc
,
172 scm_sizet (*free
) (SCM
),
173 int (*print
) (SCM
, SCM
, scm_print_state
*),
174 SCM (*equalp
) (SCM
, SCM
));
176 /* Function for creating smobs */
178 extern SCM
scm_make_smob (long tc
);
179 extern void scm_smob_prehistory (void);