Commit | Line | Data |
---|---|---|
2b829bbb | 1 | /* Copyright (C) 1995,1996,1999,2000,2001, 2003, 2004, 2006 Free Software Foundation, Inc. |
1d9ee7c7 | 2 | * |
73be1d9e MV |
3 | * This library is free software; you can redistribute it and/or |
4 | * modify it under the terms of the GNU Lesser General Public | |
5 | * License as published by the Free Software Foundation; either | |
6 | * version 2.1 of the License, or (at your option) any later version. | |
1d9ee7c7 | 7 | * |
73be1d9e MV |
8 | * This library is distributed in the hope that it will be useful, |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
11 | * Lesser General Public License for more details. | |
1d9ee7c7 | 12 | * |
73be1d9e MV |
13 | * You should have received a copy of the GNU Lesser General Public |
14 | * License along with this library; if not, write to the Free Software | |
92205699 | 15 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
73be1d9e | 16 | */ |
1bbd0b84 | 17 | |
1bbd0b84 | 18 | |
1d9ee7c7 MD |
19 | \f |
20 | ||
da7f71d7 MD |
21 | /* This file and objects.h contains those minimal pieces of the Guile |
22 | * Object Oriented Programming System which need to be included in | |
23 | * libguile. See the comments in objects.h. | |
1d9ee7c7 MD |
24 | */ |
25 | ||
a0599745 MD |
26 | #include "libguile/_scm.h" |
27 | ||
28 | #include "libguile/struct.h" | |
29 | #include "libguile/procprop.h" | |
30 | #include "libguile/chars.h" | |
31 | #include "libguile/keywords.h" | |
32 | #include "libguile/smob.h" | |
33 | #include "libguile/eval.h" | |
34 | #include "libguile/alist.h" | |
35 | #include "libguile/ports.h" | |
36 | #include "libguile/strings.h" | |
37 | #include "libguile/vectors.h" | |
38 | ||
39 | #include "libguile/validate.h" | |
40 | #include "libguile/objects.h" | |
38c9cccb MV |
41 | #include "libguile/goops.h" |
42 | ||
1d9ee7c7 MD |
43 | \f |
44 | ||
45 | SCM scm_metaclass_standard; | |
da7f71d7 | 46 | SCM scm_metaclass_operator; |
1d9ee7c7 | 47 | |
5843e5c9 DH |
48 | /* The cache argument for scm_mcache_lookup_cmethod has one of two possible |
49 | * formats: | |
50 | * | |
51 | * Format #1: | |
52 | * (SCM_IM_DISPATCH ARGS N-SPECIALIZED | |
a12be546 MD |
53 | * #((TYPE1 ... ENV FORMALS FORM ...) ...) |
54 | * GF) | |
55 | * | |
5843e5c9 | 56 | * Format #2: |
a12be546 MD |
57 | * (SCM_IM_HASH_DISPATCH ARGS N-SPECIALIZED HASHSET MASK |
58 | * #((TYPE1 ... ENV FORMALS FORM ...) ...) | |
59 | * GF) | |
60 | * | |
61 | * ARGS is either a list of expressions, in which case they | |
62 | * are interpreted as the arguments of an application, or | |
63 | * a non-pair, which is interpreted as a single expression | |
64 | * yielding all arguments. | |
65 | * | |
66 | * SCM_IM_DISPATCH expressions in generic functions always | |
67 | * have ARGS = the symbol `args' or the iloc #@0-0. | |
68 | * | |
69 | * Need FORMALS in order to support varying arity. This | |
70 | * also avoids the need for renaming of bindings. | |
71 | * | |
72 | * We should probably not complicate this mechanism by | |
73 | * introducing "optimizations" for getters and setters or | |
74 | * primitive methods. Getters and setter will normally be | |
75 | * compiled into @slot-[ref|set!] or a procedure call. | |
76 | * They rely on the dispatch performed before executing | |
77 | * the code which contains them. | |
78 | * | |
79 | * We might want to use a more efficient representation of | |
80 | * this form in the future, perhaps after we have introduced | |
81 | * low-level support for syntax-case macros. | |
82 | */ | |
83 | ||
9de33deb MD |
84 | SCM |
85 | scm_mcache_lookup_cmethod (SCM cache, SCM args) | |
86 | { | |
e11e83f3 | 87 | unsigned long i, mask, n, end; |
9de33deb | 88 | SCM ls, methods, z = SCM_CDDR (cache); |
e11e83f3 | 89 | n = scm_to_ulong (SCM_CAR (z)); /* maximum number of specializers */ |
9de33deb MD |
90 | methods = SCM_CADR (z); |
91 | ||
4057a3e0 | 92 | if (scm_is_simple_vector (methods)) |
e11e83f3 MV |
93 | { |
94 | /* cache format #1: prepare for linear search */ | |
95 | mask = -1; | |
96 | i = 0; | |
4057a3e0 | 97 | end = SCM_SIMPLE_VECTOR_LENGTH (methods); |
e11e83f3 MV |
98 | } |
99 | else | |
9de33deb | 100 | { |
5843e5c9 | 101 | /* cache format #2: compute a hash value */ |
e11e83f3 | 102 | unsigned long hashset = scm_to_ulong (methods); |
c014a02e | 103 | long j = n; |
bab246f3 | 104 | z = SCM_CDDR (z); |
e11e83f3 | 105 | mask = scm_to_ulong (SCM_CAR (z)); |
9de33deb MD |
106 | methods = SCM_CADR (z); |
107 | i = 0; | |
108 | ls = args; | |
d2e53ed6 | 109 | if (!scm_is_null (ls)) |
a12be546 MD |
110 | do |
111 | { | |
d8c40b9f DH |
112 | i += SCM_STRUCT_DATA (scm_class_of (SCM_CAR (ls))) |
113 | [scm_si_hashsets + hashset]; | |
a12be546 MD |
114 | ls = SCM_CDR (ls); |
115 | } | |
d2e53ed6 | 116 | while (j-- && !scm_is_null (ls)); |
9de33deb MD |
117 | i &= mask; |
118 | end = i; | |
119 | } | |
120 | ||
121 | /* Search for match */ | |
122 | do | |
123 | { | |
c014a02e | 124 | long j = n; |
4057a3e0 | 125 | z = SCM_SIMPLE_VECTOR_REF (methods, i); |
9de33deb | 126 | ls = args; /* list of arguments */ |
d2e53ed6 | 127 | if (!scm_is_null (ls)) |
a12be546 MD |
128 | do |
129 | { | |
130 | /* More arguments than specifiers => CLASS != ENV */ | |
bc36d050 | 131 | if (! scm_is_eq (scm_class_of (SCM_CAR (ls)), SCM_CAR (z))) |
a12be546 MD |
132 | goto next_method; |
133 | ls = SCM_CDR (ls); | |
134 | z = SCM_CDR (z); | |
135 | } | |
d2e53ed6 | 136 | while (j-- && !scm_is_null (ls)); |
9de33deb | 137 | /* Fewer arguments than specifiers => CAR != ENV */ |
d2e53ed6 | 138 | if (scm_is_null (SCM_CAR (z)) || scm_is_pair (SCM_CAR (z))) |
5843e5c9 | 139 | return z; |
9de33deb MD |
140 | next_method: |
141 | i = (i + 1) & mask; | |
142 | } while (i != end); | |
143 | return SCM_BOOL_F; | |
144 | } | |
145 | ||
146 | SCM | |
a12be546 | 147 | scm_mcache_compute_cmethod (SCM cache, SCM args) |
9de33deb MD |
148 | { |
149 | SCM cmethod = scm_mcache_lookup_cmethod (cache, args); | |
7888309b | 150 | if (scm_is_false (cmethod)) |
9de33deb MD |
151 | /* No match - memoize */ |
152 | return scm_memoize_method (cache, args); | |
153 | return cmethod; | |
154 | } | |
155 | ||
156 | SCM | |
a12be546 | 157 | scm_apply_generic (SCM gf, SCM args) |
9de33deb | 158 | { |
a12be546 | 159 | SCM cmethod = scm_mcache_compute_cmethod (SCM_ENTITY_PROCEDURE (gf), args); |
9de33deb MD |
160 | return scm_eval_body (SCM_CDR (SCM_CMETHOD_CODE (cmethod)), |
161 | SCM_EXTEND_ENV (SCM_CAR (SCM_CMETHOD_CODE (cmethod)), | |
162 | args, | |
163 | SCM_CMETHOD_ENV (cmethod))); | |
164 | } | |
165 | ||
166 | SCM | |
a12be546 | 167 | scm_call_generic_0 (SCM gf) |
9de33deb | 168 | { |
a12be546 | 169 | return scm_apply_generic (gf, SCM_EOL); |
9de33deb MD |
170 | } |
171 | ||
172 | SCM | |
a12be546 | 173 | scm_call_generic_1 (SCM gf, SCM a1) |
9de33deb | 174 | { |
1afff620 | 175 | return scm_apply_generic (gf, scm_list_1 (a1)); |
9de33deb MD |
176 | } |
177 | ||
178 | SCM | |
a12be546 MD |
179 | scm_call_generic_2 (SCM gf, SCM a1, SCM a2) |
180 | { | |
1afff620 | 181 | return scm_apply_generic (gf, scm_list_2 (a1, a2)); |
a12be546 MD |
182 | } |
183 | ||
184 | SCM | |
185 | scm_call_generic_3 (SCM gf, SCM a1, SCM a2, SCM a3) | |
9de33deb | 186 | { |
1afff620 | 187 | return scm_apply_generic (gf, scm_list_3 (a1, a2, a3)); |
9de33deb MD |
188 | } |
189 | ||
a1ec6916 | 190 | SCM_DEFINE (scm_entity_p, "entity?", 1, 0, 0, |
1bbd0b84 | 191 | (SCM obj), |
99ca0a7f | 192 | "Return @code{#t} if @var{obj} is an entity.") |
1bbd0b84 | 193 | #define FUNC_NAME s_scm_entity_p |
19c0dec2 | 194 | { |
7888309b | 195 | return scm_from_bool(SCM_STRUCTP (obj) && SCM_I_ENTITYP (obj)); |
19c0dec2 | 196 | } |
1bbd0b84 | 197 | #undef FUNC_NAME |
19c0dec2 | 198 | |
a1ec6916 | 199 | SCM_DEFINE (scm_operator_p, "operator?", 1, 0, 0, |
1bbd0b84 | 200 | (SCM obj), |
99ca0a7f | 201 | "Return @code{#t} if @var{obj} is an operator.") |
1bbd0b84 | 202 | #define FUNC_NAME s_scm_operator_p |
a43a8375 | 203 | { |
7888309b | 204 | return scm_from_bool(SCM_STRUCTP (obj) |
1bbd0b84 GB |
205 | && SCM_I_OPERATORP (obj) |
206 | && !SCM_I_ENTITYP (obj)); | |
a43a8375 | 207 | } |
1bbd0b84 | 208 | #undef FUNC_NAME |
a43a8375 | 209 | |
cec0d28c MV |
210 | /* XXX - What code requires the object procedure to be only of certain |
211 | types? */ | |
212 | ||
213 | SCM_DEFINE (scm_valid_object_procedure_p, "valid-object-procedure?", 1, 0, 0, | |
214 | (SCM proc), | |
215 | "Return @code{#t} iff @var{proc} is a procedure that can be used " | |
216 | "with @code{set-object-procedure}. It is always valid to use " | |
217 | "a closure constructed by @code{lambda}.") | |
218 | #define FUNC_NAME s_scm_valid_object_procedure_p | |
219 | { | |
220 | if (SCM_IMP (proc)) | |
221 | return SCM_BOOL_F; | |
222 | switch (SCM_TYP7 (proc)) | |
223 | { | |
224 | default: | |
225 | return SCM_BOOL_F; | |
226 | case scm_tcs_closures: | |
227 | case scm_tc7_subr_1: | |
228 | case scm_tc7_subr_2: | |
229 | case scm_tc7_subr_3: | |
230 | case scm_tc7_lsubr_2: | |
231 | return SCM_BOOL_T; | |
232 | } | |
233 | } | |
234 | #undef FUNC_NAME | |
235 | ||
a1ec6916 | 236 | SCM_DEFINE (scm_set_object_procedure_x, "set-object-procedure!", 2, 0, 0, |
1bbd0b84 | 237 | (SCM obj, SCM proc), |
cec0d28c | 238 | "Set the object procedure of @var{obj} to @var{proc}.\n" |
99ca0a7f | 239 | "@var{obj} must be either an entity or an operator.") |
1bbd0b84 | 240 | #define FUNC_NAME s_scm_set_object_procedure_x |
47b21050 | 241 | { |
0c95b57d | 242 | SCM_ASSERT (SCM_STRUCTP (obj) |
c1a6fd8f MD |
243 | && ((SCM_CLASS_FLAGS (obj) & SCM_CLASSF_OPERATOR) |
244 | || (SCM_I_ENTITYP (obj) | |
245 | && !(SCM_OBJ_CLASS_FLAGS (obj) | |
246 | & SCM_CLASSF_PURE_GENERIC))), | |
47b21050 MD |
247 | obj, |
248 | SCM_ARG1, | |
1bbd0b84 | 249 | FUNC_NAME); |
cec0d28c | 250 | SCM_ASSERT (scm_valid_object_procedure_p (proc), proc, SCM_ARG2, FUNC_NAME); |
a12be546 | 251 | if (SCM_I_ENTITYP (obj)) |
d8c40b9f | 252 | SCM_SET_ENTITY_PROCEDURE (obj, proc); |
a12be546 MD |
253 | else |
254 | SCM_OPERATOR_CLASS (obj)->procedure = proc; | |
47b21050 MD |
255 | return SCM_UNSPECIFIED; |
256 | } | |
1bbd0b84 | 257 | #undef FUNC_NAME |
47b21050 | 258 | |
a43a8375 | 259 | #ifdef GUILE_DEBUG |
a1ec6916 | 260 | SCM_DEFINE (scm_object_procedure, "object-procedure", 1, 0, 0, |
1bbd0b84 | 261 | (SCM obj), |
99ca0a7f MG |
262 | "Return the object procedure of @var{obj}. @var{obj} must be\n" |
263 | "an entity or an operator.") | |
1bbd0b84 | 264 | #define FUNC_NAME s_scm_object_procedure |
a43a8375 | 265 | { |
0c95b57d | 266 | SCM_ASSERT (SCM_STRUCTP (obj) |
a12be546 MD |
267 | && ((SCM_CLASS_FLAGS (obj) & SCM_CLASSF_OPERATOR) |
268 | || SCM_I_ENTITYP (obj)), | |
1bbd0b84 | 269 | obj, SCM_ARG1, FUNC_NAME); |
a43a8375 | 270 | return (SCM_I_ENTITYP (obj) |
a12be546 MD |
271 | ? SCM_ENTITY_PROCEDURE (obj) |
272 | : SCM_OPERATOR_CLASS (obj)->procedure); | |
a43a8375 | 273 | } |
1bbd0b84 | 274 | #undef FUNC_NAME |
a43a8375 MD |
275 | #endif /* GUILE_DEBUG */ |
276 | ||
ed6e0c83 MD |
277 | /* The following procedures are not a part of Goops but a minimal |
278 | * object system built upon structs. They are here for those who | |
279 | * want to implement their own object system. | |
280 | */ | |
281 | ||
036737fc MD |
282 | SCM |
283 | scm_i_make_class_object (SCM meta, | |
284 | SCM layout_string, | |
c014a02e | 285 | unsigned long flags) |
47b21050 MD |
286 | { |
287 | SCM c; | |
036737fc | 288 | SCM layout = scm_make_struct_layout (layout_string); |
47b21050 MD |
289 | c = scm_make_struct (meta, |
290 | SCM_INUM0, | |
1afff620 | 291 | scm_list_4 (layout, SCM_BOOL_F, SCM_EOL, SCM_EOL)); |
47b21050 MD |
292 | SCM_SET_CLASS_FLAGS (c, flags); |
293 | return c; | |
294 | } | |
295 | ||
a1ec6916 | 296 | SCM_DEFINE (scm_make_class_object, "make-class-object", 2, 0, 0, |
1bbd0b84 | 297 | (SCM metaclass, SCM layout), |
99ca0a7f MG |
298 | "Create a new class object of class @var{metaclass}, with the\n" |
299 | "slot layout specified by @var{layout}.") | |
1bbd0b84 | 300 | #define FUNC_NAME s_scm_make_class_object |
47b21050 | 301 | { |
c014a02e | 302 | unsigned long flags = 0; |
34d19ef6 HWN |
303 | SCM_VALIDATE_STRUCT (1, metaclass); |
304 | SCM_VALIDATE_STRING (2, layout); | |
bc36d050 | 305 | if (scm_is_eq (metaclass, scm_metaclass_operator)) |
47b21050 | 306 | flags = SCM_CLASSF_OPERATOR; |
036737fc | 307 | return scm_i_make_class_object (metaclass, layout, flags); |
47b21050 | 308 | } |
1bbd0b84 | 309 | #undef FUNC_NAME |
47b21050 | 310 | |
a1ec6916 | 311 | SCM_DEFINE (scm_make_subclass_object, "make-subclass-object", 2, 0, 0, |
1bbd0b84 | 312 | (SCM class, SCM layout), |
99ca0a7f MG |
313 | "Create a subclass object of @var{class}, with the slot layout\n" |
314 | "specified by @var{layout}.") | |
1bbd0b84 | 315 | #define FUNC_NAME s_scm_make_subclass_object |
47b21050 MD |
316 | { |
317 | SCM pl; | |
34d19ef6 HWN |
318 | SCM_VALIDATE_STRUCT (1, class); |
319 | SCM_VALIDATE_STRING (2, layout); | |
d8c40b9f | 320 | pl = SCM_PACK (SCM_STRUCT_DATA (class) [scm_vtable_index_layout]); |
cc95e00a | 321 | pl = scm_symbol_to_string (pl); |
036737fc | 322 | return scm_i_make_class_object (SCM_STRUCT_VTABLE (class), |
1afff620 | 323 | scm_string_append (scm_list_2 (pl, layout)), |
036737fc | 324 | SCM_CLASS_FLAGS (class)); |
47b21050 | 325 | } |
1bbd0b84 | 326 | #undef FUNC_NAME |
47b21050 | 327 | |
1d9ee7c7 MD |
328 | void |
329 | scm_init_objects () | |
330 | { | |
cc95e00a | 331 | SCM ms = scm_from_locale_string (SCM_METACLASS_STANDARD_LAYOUT); |
3ce4544c | 332 | SCM mt = scm_make_vtable_vtable (ms, SCM_INUM0, |
1afff620 | 333 | scm_list_3 (SCM_BOOL_F, SCM_EOL, SCM_EOL)); |
1d9ee7c7 | 334 | |
cc95e00a | 335 | SCM os = scm_from_locale_string (SCM_METACLASS_OPERATOR_LAYOUT); |
3ce4544c | 336 | SCM ot = scm_make_vtable_vtable (os, SCM_INUM0, |
1afff620 | 337 | scm_list_3 (SCM_BOOL_F, SCM_EOL, SCM_EOL)); |
da7f71d7 | 338 | |
cc95e00a | 339 | SCM es = scm_from_locale_string (SCM_ENTITY_LAYOUT); |
1d9ee7c7 MD |
340 | SCM el = scm_make_struct_layout (es); |
341 | SCM et = scm_make_struct (mt, SCM_INUM0, | |
1afff620 | 342 | scm_list_4 (el, SCM_BOOL_F, SCM_EOL, SCM_EOL)); |
1d9ee7c7 | 343 | |
86d31dfe | 344 | scm_c_define ("<class>", mt); |
1d9ee7c7 | 345 | scm_metaclass_standard = mt; |
86d31dfe | 346 | scm_c_define ("<operator-class>", ot); |
da7f71d7 MD |
347 | scm_metaclass_operator = ot; |
348 | SCM_SET_CLASS_FLAGS (et, SCM_CLASSF_OPERATOR | SCM_CLASSF_ENTITY); | |
135e76f8 | 349 | SCM_SET_CLASS_DESTRUCTOR (et, scm_struct_free_entity); |
86d31dfe | 350 | scm_c_define ("<entity>", et); |
47b21050 | 351 | |
a0599745 | 352 | #include "libguile/objects.x" |
1d9ee7c7 | 353 | } |
89e00824 ML |
354 | |
355 | /* | |
356 | Local Variables: | |
357 | c-file-style: "gnu" | |
358 | End: | |
359 | */ |