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