Commit | Line | Data |
---|---|---|
0f2d19dd JB |
1 | /* classes: h_files */ |
2 | ||
7a7f7c53 DH |
3 | #ifndef SCM_SMOB_H |
4 | #define SCM_SMOB_H | |
dee01b01 | 5 | |
cc7005bc | 6 | /* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006, 2009, 2010 Free Software Foundation, Inc. |
dee01b01 | 7 | * |
73be1d9e | 8 | * This library is free software; you can redistribute it and/or |
53befeb7 NJ |
9 | * modify it under the terms of the GNU Lesser General Public License |
10 | * as published by the Free Software Foundation; either version 3 of | |
11 | * the License, or (at your option) any later version. | |
dee01b01 | 12 | * |
53befeb7 NJ |
13 | * This library is distributed in the hope that it will be useful, but |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
73be1d9e MV |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
16 | * Lesser General Public License for more details. | |
dee01b01 | 17 | * |
73be1d9e MV |
18 | * You should have received a copy of the GNU Lesser General Public |
19 | * License along with this library; if not, write to the Free Software | |
53befeb7 NJ |
20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
21 | * 02110-1301 USA | |
73be1d9e | 22 | */ |
dee01b01 | 23 | |
0f2d19dd | 24 | \f |
dee01b01 | 25 | |
b4309c3c | 26 | #include "libguile/__scm.h" |
b08323d1 | 27 | #include "libguile/print.h" |
0f2d19dd | 28 | |
1c44468d | 29 | #include "libguile/bdw-gc.h" |
10fb3386 LC |
30 | |
31 | ||
0f2d19dd | 32 | \f |
9dd5943c MD |
33 | /* This is the internal representation of a smob type */ |
34 | ||
35 | typedef struct scm_smob_descriptor | |
36 | { | |
da0e6c2b | 37 | char const *name; |
1be6b49c | 38 | size_t size; |
7866a09b | 39 | SCM (*mark) (SCM); |
1be6b49c | 40 | size_t (*free) (SCM); |
7866a09b GB |
41 | int (*print) (SCM exp, SCM port, scm_print_state *pstate); |
42 | SCM (*equalp) (SCM, SCM); | |
cb1c46c5 KN |
43 | SCM (*apply) (); |
44 | SCM (*apply_0) (SCM); | |
45 | SCM (*apply_1) (SCM, SCM); | |
46 | SCM (*apply_2) (SCM, SCM, SCM); | |
47 | SCM (*apply_3) (SCM, SCM, SCM, SCM); | |
68b06924 | 48 | int gsubr_type; /* Used in procprop.c */ |
9dd5943c MD |
49 | } scm_smob_descriptor; |
50 | ||
378f2625 | 51 | |
0f2d19dd | 52 | \f |
378f2625 LC |
53 | SCM_API SCM scm_i_new_smob_with_mark_proc (scm_t_bits tc, |
54 | scm_t_bits, scm_t_bits, scm_t_bits); | |
55 | ||
56 | ||
0f2d19dd | 57 | |
10fb3386 LC |
58 | #define SCM_NEWSMOB(z, tc, data) \ |
59 | do \ | |
60 | { \ | |
61 | register scm_t_bits _smobnum = SCM_TC2SMOBNUM (tc); \ | |
62 | z = (scm_smobs[_smobnum].mark \ | |
63 | ? scm_i_new_smob_with_mark_proc ((tc), (scm_t_bits)(data), \ | |
64 | 0, 0) \ | |
65 | : scm_cell (tc, (scm_t_bits)(data))); \ | |
66 | if (scm_smobs[_smobnum].free) \ | |
67 | { \ | |
68 | GC_finalization_proc _prev_finalizer; \ | |
69 | GC_PTR _prev_finalizer_data; \ | |
70 | \ | |
71 | GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (z), scm_i_finalize_smob, \ | |
72 | NULL, \ | |
73 | &_prev_finalizer, \ | |
74 | &_prev_finalizer_data); \ | |
75 | } \ | |
76 | } \ | |
378f2625 | 77 | while (0) |
23a62151 | 78 | |
378f2625 LC |
79 | #define SCM_RETURN_NEWSMOB(tc, data) \ |
80 | do { SCM __SCM_smob_answer; \ | |
81 | SCM_NEWSMOB (__SCM_smob_answer, (tc), (data)); \ | |
82 | return __SCM_smob_answer; \ | |
23a62151 MD |
83 | } while (0) |
84 | ||
378f2625 LC |
85 | #define SCM_NEWSMOB2(z, tc, data1, data2) \ |
86 | SCM_NEWSMOB3 (z, tc, data1, data2, 0) | |
87621a14 | 87 | |
378f2625 LC |
88 | #define SCM_RETURN_NEWSMOB2(tc, data1, data2) \ |
89 | do { SCM __SCM_smob_answer; \ | |
90 | SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2)); \ | |
91 | return __SCM_smob_answer; \ | |
87621a14 MD |
92 | } while (0) |
93 | ||
10fb3386 LC |
94 | #define SCM_NEWSMOB3(z, tc, data1, data2, data3) \ |
95 | do \ | |
96 | { \ | |
97 | register scm_t_bits _smobnum = SCM_TC2SMOBNUM (tc); \ | |
98 | z = (scm_smobs[_smobnum].mark \ | |
99 | ? scm_i_new_smob_with_mark_proc (tc, (scm_t_bits)(data1), \ | |
100 | (scm_t_bits)(data2), \ | |
101 | (scm_t_bits)(data3)) \ | |
102 | : scm_double_cell ((tc), (scm_t_bits)(data1), \ | |
103 | (scm_t_bits)(data2), \ | |
104 | (scm_t_bits)(data3))); \ | |
105 | if (scm_smobs[_smobnum].free) \ | |
106 | { \ | |
107 | GC_finalization_proc _prev_finalizer; \ | |
108 | GC_PTR _prev_finalizer_data; \ | |
109 | \ | |
110 | GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (z), scm_i_finalize_smob, \ | |
111 | NULL, \ | |
112 | &_prev_finalizer, \ | |
113 | &_prev_finalizer_data); \ | |
114 | } \ | |
115 | } \ | |
378f2625 | 116 | while (0) |
87621a14 | 117 | |
378f2625 LC |
118 | #define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3) \ |
119 | do { SCM __SCM_smob_answer; \ | |
120 | SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3)); \ | |
121 | return __SCM_smob_answer; \ | |
87621a14 MD |
122 | } while (0) |
123 | ||
9dd5943c | 124 | |
56164dc4 AW |
125 | #define SCM_SMOB_DATA_N(x, n) (SCM_CELL_WORD ((x), (n))) |
126 | #define SCM_SET_SMOB_DATA_N(x, n, data) (SCM_SET_CELL_WORD ((x), (n), (data))) | |
127 | ||
128 | #define SCM_SMOB_DATA_0(x) (SCM_SMOB_DATA_N ((x), 0)) | |
129 | #define SCM_SMOB_DATA_1(x) (SCM_SMOB_DATA_N ((x), 1)) | |
130 | #define SCM_SMOB_DATA_2(x) (SCM_SMOB_DATA_N ((x), 2)) | |
131 | #define SCM_SMOB_DATA_3(x) (SCM_SMOB_DATA_N ((x), 3)) | |
132 | #define SCM_SET_SMOB_DATA_0(x, data) (SCM_SET_SMOB_DATA_N ((x), 0, (data))) | |
133 | #define SCM_SET_SMOB_DATA_1(x, data) (SCM_SET_SMOB_DATA_N ((x), 1, (data))) | |
134 | #define SCM_SET_SMOB_DATA_2(x, data) (SCM_SET_SMOB_DATA_N ((x), 2, (data))) | |
135 | #define SCM_SET_SMOB_DATA_3(x, data) (SCM_SET_SMOB_DATA_N ((x), 3, (data))) | |
136 | ||
137 | #define SCM_SMOB_FLAGS(x) (SCM_SMOB_DATA_0 (x) >> 16) | |
138 | #define SCM_SMOB_DATA(x) (SCM_SMOB_DATA_1 (x)) | |
139 | #define SCM_SET_SMOB_FLAGS(x, data) (SCM_SET_SMOB_DATA_0 ((x), (SCM_CELL_TYPE (x)&0xffff)|((data)<<16))) | |
140 | #define SCM_SET_SMOB_DATA(x, data) (SCM_SET_SMOB_DATA_1 ((x), (data))) | |
141 | ||
142 | #define SCM_SMOB_OBJECT_N(x,n) (SCM_CELL_OBJECT ((x), (n))) | |
143 | #define SCM_SET_SMOB_OBJECT_N(x,n,obj) (SCM_SET_CELL_OBJECT ((x), (n), (obj))) | |
144 | #define SCM_SMOB_OBJECT_N_LOC(x,n) (SCM_CELL_OBJECT_LOC ((x), (n))) | |
145 | ||
146 | /*#define SCM_SMOB_OBJECT_0(x) (SCM_SMOB_OBJECT_N ((x), 0))*/ | |
147 | #define SCM_SMOB_OBJECT_1(x) (SCM_SMOB_OBJECT_N ((x), 1)) | |
148 | #define SCM_SMOB_OBJECT_2(x) (SCM_SMOB_OBJECT_N ((x), 2)) | |
149 | #define SCM_SMOB_OBJECT_3(x) (SCM_SMOB_OBJECT_N ((x), 3)) | |
150 | /*#define SCM_SET_SMOB_OBJECT_0(x,obj) (SCM_SET_SMOB_OBJECT_N ((x), 0, (obj)))*/ | |
151 | #define SCM_SET_SMOB_OBJECT_1(x,obj) (SCM_SET_SMOB_OBJECT_N ((x), 1, (obj))) | |
152 | #define SCM_SET_SMOB_OBJECT_2(x,obj) (SCM_SET_SMOB_OBJECT_N ((x), 2, (obj))) | |
153 | #define SCM_SET_SMOB_OBJECT_3(x,obj) (SCM_SET_SMOB_OBJECT_N ((x), 3, (obj))) | |
154 | #define SCM_SMOB_OBJECT_0_LOC(x) (SCM_SMOB_OBJECT_N_LOC ((x), 0))) | |
155 | #define SCM_SMOB_OBJECT_1_LOC(x) (SCM_SMOB_OBJECT_N_LOC ((x), 1))) | |
156 | #define SCM_SMOB_OBJECT_2_LOC(x) (SCM_SMOB_OBJECT_N_LOC ((x), 2))) | |
157 | #define SCM_SMOB_OBJECT_3_LOC(x) (SCM_SMOB_OBJECT_N_LOC ((x), 3))) | |
158 | ||
159 | #define SCM_SMOB_OBJECT(x) (SCM_SMOB_OBJECT_1 (x)) | |
160 | #define SCM_SET_SMOB_OBJECT(x,obj) (SCM_SET_SMOB_OBJECT_1 ((x), (obj))) | |
161 | #define SCM_SMOB_OBJECT_LOC(x) (SCM_SMOB_OBJECT_1_LOC (x))) | |
162 | ||
37fc18ae | 163 | |
735bcfe5 AW |
164 | #define SCM_SMOB_TYPE_MASK 0xffff |
165 | #define SCM_SMOB_TYPE_BITS(tc) (tc) | |
94113249 DH |
166 | #define SCM_TC2SMOBNUM(x) (0x0ff & ((x) >> 8)) |
167 | #define SCM_SMOBNUM(x) (SCM_TC2SMOBNUM (SCM_CELL_TYPE (x))) | |
2c16a78a | 168 | /* SCM_SMOBNAME can be 0 if name is missing */ |
94113249 | 169 | #define SCM_SMOBNAME(smobnum) (scm_smobs[smobnum].name) |
e841c3e0 | 170 | #define SCM_SMOB_PREDICATE(tag, obj) SCM_TYP16_PREDICATE (tag, obj) |
0717dfd8 | 171 | #define SCM_SMOB_DESCRIPTOR(x) (scm_smobs[SCM_SMOBNUM (x)]) |
68b06924 KN |
172 | #define SCM_SMOB_APPLICABLE_P(x) (SCM_SMOB_DESCRIPTOR (x).apply) |
173 | #define SCM_SMOB_APPLY_0(x) (SCM_SMOB_DESCRIPTOR (x).apply_0 (x)) | |
34d19ef6 HWN |
174 | #define SCM_SMOB_APPLY_1(x, a1) (SCM_SMOB_DESCRIPTOR (x).apply_1 (x, (a1))) |
175 | #define SCM_SMOB_APPLY_2(x, a1, a2) (SCM_SMOB_DESCRIPTOR (x).apply_2 (x, (a1), (a2))) | |
176 | #define SCM_SMOB_APPLY_3(x, a1, a2, rst) (SCM_SMOB_DESCRIPTOR (x).apply_3 (x, (a1), (a2), (rst))) | |
0f2d19dd | 177 | |
c891a40e LC |
178 | /* Maximum number of SMOB types. */ |
179 | #define SCM_I_MAX_SMOB_TYPE_COUNT 256 | |
180 | ||
33b001fd MV |
181 | SCM_API long scm_numsmob; |
182 | SCM_API scm_smob_descriptor scm_smobs[]; | |
0f2d19dd | 183 | |
10fb3386 | 184 | SCM_API void scm_i_finalize_smob (GC_PTR obj, GC_PTR data); |
37fc18ae | 185 | |
0f2d19dd | 186 | \f |
0f2d19dd | 187 | |
33b001fd MV |
188 | SCM_API SCM scm_mark0 (SCM ptr); |
189 | SCM_API SCM scm_markcdr (SCM ptr); | |
190 | SCM_API size_t scm_free0 (SCM ptr); | |
33b001fd | 191 | SCM_API int scm_smob_print (SCM exp, SCM port, scm_print_state *pstate); |
23a62151 | 192 | |
c72baaaa MD |
193 | /* The following set of functions is the standard way to create new |
194 | * SMOB types. | |
195 | * | |
196 | * Create a type tag using `scm_make_smob_type', accept default values | |
197 | * for mark, free, print and/or equalp functions, or set your own | |
198 | * values using `scm_set_smob_xxx'. | |
199 | */ | |
23a62151 | 200 | |
df5af69a | 201 | SCM_API scm_t_bits scm_make_smob_type (char const *name, size_t size); |
23a62151 | 202 | |
33b001fd MV |
203 | SCM_API void scm_set_smob_mark (scm_t_bits tc, SCM (*mark) (SCM)); |
204 | SCM_API void scm_set_smob_free (scm_t_bits tc, size_t (*free) (SCM)); | |
205 | SCM_API void scm_set_smob_print (scm_t_bits tc, | |
206 | int (*print) (SCM, SCM, scm_print_state*)); | |
207 | SCM_API void scm_set_smob_equalp (scm_t_bits tc, SCM (*equalp) (SCM, SCM)); | |
208 | SCM_API void scm_set_smob_apply (scm_t_bits tc, | |
209 | SCM (*apply) (), | |
210 | unsigned int req, | |
211 | unsigned int opt, | |
212 | unsigned int rst); | |
c72baaaa | 213 | |
197b0573 MV |
214 | SCM_API void scm_assert_smob_type (scm_t_bits tag, SCM val); |
215 | ||
7c58e21b | 216 | /* Function for creating smobs */ |
c72baaaa | 217 | |
33b001fd | 218 | SCM_API SCM scm_make_smob (scm_t_bits tc); |
197b0573 | 219 | |
cc7005bc AW |
220 | SCM_INTERNAL int scm_i_smob_arity (SCM proc, int *req, int *opt, int *rest); |
221 | ||
33b001fd | 222 | SCM_API void scm_smob_prehistory (void); |
7c58e21b | 223 | |
7a7f7c53 | 224 | #endif /* SCM_SMOB_H */ |
89e00824 ML |
225 | |
226 | /* | |
227 | Local Variables: | |
228 | c-file-style: "gnu" | |
229 | End: | |
230 | */ |