HCoop / bpt / guile.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
%invalidate-method-cache invalidates the dispatch procedure too
[bpt/guile.git] / libguile / goops.h
CommitLineData
0518d3e2
MD		 1/* classes: h_files */
2
729dbac3
DH		 3#ifndef SCM_GOOPS_H
4#define SCM_GOOPS_H
a392ee15 5
04795a1c 6/* Copyright (C) 1998,1999,2000,2001,2002,2003, 2006, 2008, 2009 Free Software Foundation, Inc.
a392ee15 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.
a392ee15 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.
a392ee15 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 */
a392ee15 23
0518d3e2
MD		 24\f
25
26/* This software is a derivative work of other copyrighted softwares; the
27 * copyright notices of these softwares are placed in the file COPYRIGHTS
28 *
29 * This file is based upon stklos.h from the STk distribution by
30 * Erick Gallesio <eg@unice.fr>.
31 */
32
33#include "libguile/__scm.h"
34
398d8ee1
KN		 35#include "libguile/validate.h"
36
b6cf4d02
AW		 37/* {Class flags}
38 *
39 * These are used for efficient identification of instances of a
40 * certain class or its subclasses when traversal of the inheritance
41 * graph would be too costly.
42 */
43#define SCM_VTABLE_FLAG_GOOPS_CLASS SCM_VTABLE_FLAG_GOOPS_0
44#define SCM_VTABLE_FLAG_GOOPS_VALID SCM_VTABLE_FLAG_GOOPS_1
45#define SCM_VTABLE_FLAG_GOOPS_METACLASS SCM_VTABLE_FLAG_GOOPS_2
46#define SCM_VTABLE_FLAG_GOOPS_FOREIGN SCM_VTABLE_FLAG_GOOPS_3
47#define SCM_VTABLE_FLAG_GOOPS_PURE_GENERIC SCM_VTABLE_FLAG_GOOPS_4
48#define SCM_VTABLE_FLAG_GOOPS_SIMPLE_METHOD SCM_VTABLE_FLAG_GOOPS_5
49#define SCM_VTABLE_FLAG_GOOPS_ACCESSOR_METHOD SCM_VTABLE_FLAG_GOOPS_6
50
51#define SCM_CLASS_OF(x) SCM_STRUCT_VTABLE (x)
52#define SCM_CLASS_FLAGS(class) (SCM_VTABLE_FLAGS (class))
53#define SCM_OBJ_CLASS_FLAGS(obj) (SCM_STRUCT_VTABLE_FLAGS (obj))
54#define SCM_SET_CLASS_FLAGS(c, f) (SCM_SET_VTABLE_FLAGS (c, f))
55#define SCM_CLEAR_CLASS_FLAGS(c, f) (SCM_CLEAR_VTABLE_FLAGS (c, f))
56
57#define SCM_CLASSF_FOREIGN SCM_VTABLE_FLAG_GOOPS_FOREIGN
58#define SCM_CLASSF_METACLASS SCM_VTABLE_FLAG_GOOPS_METACLASS
59#define SCM_CLASSF_PURE_GENERIC SCM_VTABLE_FLAG_GOOPS_PURE_GENERIC
60#define SCM_CLASSF_GOOPS_VALID SCM_VTABLE_FLAG_GOOPS_VALID
61#define SCM_CLASSF_GOOPS SCM_VTABLE_FLAG_GOOPS_CLASS
62#define SCM_CLASSF_SIMPLE_METHOD SCM_VTABLE_FLAG_GOOPS_SIMPLE_METHOD
63#define SCM_CLASSF_ACCESSOR_METHOD SCM_VTABLE_FLAG_GOOPS_ACCESSOR_METHOD
64#define SCM_CLASSF_GOOPS_OR_VALID (SCM_CLASSF_GOOPS | SCM_CLASSF_GOOPS_VALID)
65
0518d3e2
MD		 66/*
67 * scm_class_class
68 */
69
b6cf4d02
AW		 70/* see also, SCM_VTABLE_BASE_LAYOUT, and build_class_class_slots */
71#define SCM_CLASS_CLASS_LAYOUT \
72 "pw" /* redefined */ \
73 "ur" /* h0 */ \
74 "ur" /* h1 */ \
75 "ur" /* h2 */ \
76 "ur" /* h3 */ \
77 "ur" /* h4 */ \
78 "ur" /* h5 */ \
79 "ur" /* h6 */ \
80 "ur" /* h7 */ \
81 "pw" /* direct supers */ \
82 "pw" /* direct slots */ \
83 "pw" /* direct subclasses */ \
84 "pw" /* direct methods */ \
85 "pw" /* cpl */ \
86 "pw" /* default-slot-definition-class */ \
87 "pw" /* slots */ \
88 "pw" /* getters-n-setters */ \
89 "pw" /* keyword access */ \
90 "pw" /* nfields */ \
91 "pw" /* environment */
92
93#define scm_si_redefined (scm_vtable_offset_user + 0)
94#define scm_si_h0 (scm_vtable_offset_user + 1)
95#define scm_si_hashsets scm_si_h0
96#define scm_si_h1 (scm_vtable_offset_user + 2)
97#define scm_si_h2 (scm_vtable_offset_user + 3)
98#define scm_si_h3 (scm_vtable_offset_user + 4)
99#define scm_si_h4 (scm_vtable_offset_user + 5)
100#define scm_si_h5 (scm_vtable_offset_user + 6)
101#define scm_si_h6 (scm_vtable_offset_user + 7)
102#define scm_si_h7 (scm_vtable_offset_user + 8)
103#define scm_si_direct_supers (scm_vtable_offset_user + 9) /* (class ...) */
104#define scm_si_direct_slots (scm_vtable_offset_user + 10) /* ((name . options) ...) */
105#define scm_si_direct_subclasses (scm_vtable_offset_user + 11) /* (class ...) */
106#define scm_si_direct_methods (scm_vtable_offset_user + 12) /* (methods ...) */
107#define scm_si_cpl (scm_vtable_offset_user + 13) /* (class ...) */
108#define scm_si_slotdef_class (scm_vtable_offset_user + 14)
109#define scm_si_slots (scm_vtable_offset_user + 15) /* ((name . options) ...) */
110#define scm_si_name_access (scm_vtable_offset_user + 16)
efcebb5b 111#define scm_si_getters_n_setters scm_si_name_access
b6cf4d02
AW		 112#define scm_si_keyword_access (scm_vtable_offset_user + 17)
113#define scm_si_nfields (scm_vtable_offset_user + 18) /* an integer */
114#define scm_si_environment (scm_vtable_offset_user + 19) /* The environment in which class is built */
115#define SCM_N_CLASS_SLOTS (scm_vtable_offset_user + 20)
0518d3e2 116
92c2555f 117typedef struct scm_t_method {
0518d3e2
MD		 118 SCM generic_function;
119 SCM specializers;
120 SCM procedure;
92c2555f 121} scm_t_method;
0518d3e2 122
92c2555f 123#define SCM_METHOD(obj) ((scm_t_method *) SCM_STRUCT_DATA (obj))
0518d3e2 124
efcebb5b 125#define SCM_OBJ_CLASS_REDEF(x) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (x) [scm_si_redefined]))
0518d3e2 126#define SCM_INST(x) SCM_STRUCT_DATA (x)
00d8d838 127
0518d3e2 128#define SCM_CLASS_OF(x) SCM_STRUCT_VTABLE (x)
729dbac3 129#define SCM_ACCESSORS_OF(x) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (x)[scm_si_getters_n_setters]))
00d8d838
DH		 130
131#define SCM_CLASSP(x) \
132 (SCM_STRUCTP (x) && SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_METACLASS)
6182ceac 133#define SCM_VALIDATE_CLASS(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, CLASSP, "class")
0518d3e2 134
25ba37df 135#define SCM_INSTANCEP(x) \
00d8d838 136 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_GOOPS))
6182ceac 137#define SCM_VALIDATE_INSTANCE(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, INSTANCEP, "instance")
0518d3e2 138
25ba37df 139#define SCM_PUREGENERICP(x) \
00d8d838 140 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_PURE_GENERIC))
6182ceac 141#define SCM_VALIDATE_PUREGENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, PUREGENERICP, "pure generic function")
e11208ca 142
00d8d838
DH		 143#define SCM_ACCESSORP(x) \
144 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_ACCESSOR_METHOD))
6182ceac 145#define SCM_VALIDATE_ACCESSOR(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, ACCESSORP, "accessor")
0518d3e2 146
b6cf4d02
AW		 147#define SCM_SLOT(x, i) (SCM_STRUCT_SLOT_REF (x, i))
148#define SCM_SET_SLOT(x, i, v) (SCM_STRUCT_SLOT_SET (x, i, v))
f12745b6 149#define SCM_INSTANCE_HASH(c, i) (SCM_INST (c) [scm_si_hashsets + (i)])
dcb410ec 150#define SCM_SET_HASHSET(c, i, h) (SCM_INST (c) [scm_si_hashsets + (i)] = (h))
00d8d838 151
7888309b 152#define SCM_SUBCLASSP(c1, c2) (scm_is_true (scm_c_memq (c2, SCM_SLOT (c1, scm_si_cpl))))
00d8d838
DH		 153#define SCM_IS_A_P(x, c) \
154 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), c))
0518d3e2 155
00d8d838
DH		 156#define SCM_GENERICP(x) \
157 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_generic))
6182ceac 158#define SCM_VALIDATE_GENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, GENERICP, "generic function")
00d8d838
DH		 159
160#define SCM_METHODP(x) \
161 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_method))
6182ceac 162#define SCM_VALIDATE_METHOD(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, METHODP, "method")
398d8ee1 163
efcebb5b 164#define SCM_SET_CLASS_DESTRUCTOR(c, d) SCM_SET_VTABLE_DESTRUCTOR (c, d)
efcebb5b 165
b6cf4d02
AW		 166#define SCM_GENERIC_METHOD_CACHE(G) (SCM_PACK (SCM_STRUCT_DATA (G) [scm_si_generic_cache]))
167#define SCM_SET_GENERIC_METHOD_CACHE(G,C) (SCM_STRUCT_DATA (G) [scm_si_generic_cache] = SCM_UNPACK (C))
0518d3e2
MD		 168#define SCM_MCACHE_N_SPECIALIZED(C) SCM_CADDR (C)
169#define SCM_SET_MCACHE_N_SPECIALIZED(C, X) SCM_SETCAR (SCM_CDDR (C), X)
170
a9a90a88
AW		 171#define SCM_SET_GENERIC_DISPATCH_PROCEDURE(G,C) (SCM_STRUCT_SLOT_SET (G, scm_si_dispatch_procedure, (C)))
172#define SCM_CLEAR_GENERIC_EFFECTIVE_METHODS(G) (SCM_STRUCT_SLOT_SET (G, scm_si_effective_methods, SCM_EOL));
173
174#define SCM_GENERIC_SETTER(G) (SCM_PACK (SCM_STRUCT_DATA (G) [scm_si_generic_setter]))
175#define SCM_SET_GENERIC_SETTER(G,C) (SCM_STRUCT_DATA (G) [scm_si_generic_setter] = SCM_UNPACK (C))
176
0518d3e2
MD		 177#define SCM_INITIAL_MCACHE_SIZE 1
178
0518d3e2
MD		 179#define scm_si_methods 0 /* offset of methods slot in a <generic> */
180#define scm_si_n_specialized 1
6d33e90f
AW		 181#define scm_si_cache_mutex 2
182#define scm_si_extended_by 3
183#define scm_si_generic_cache 4
a9a90a88
AW		 184#define scm_si_dispatch_procedure 5
185#define scm_si_effective_methods 6
186#define scm_si_generic_setter 7
0518d3e2
MD		 187
188#define scm_si_generic_function 0 /* offset of gf slot in a <method> */
189#define scm_si_specializers 1 /* offset of spec. slot in a <method> */
0518d3e2 190#define scm_si_procedure 2 /* offset of proc. slot in a <method> */
c40944c9
AW		 191#define scm_si_formals 3 /* offset of form. slot in a <method> */
192#define scm_si_body 4 /* offset of body slot in a <method> */
193#define scm_si_make_procedure 5 /* offset of makep.slot in a <method> */
0518d3e2
MD		 194
195/* C interface */
539d5410
MV		 196SCM_API SCM scm_class_boolean;
197SCM_API SCM scm_class_char;
198SCM_API SCM scm_class_pair;
199SCM_API SCM scm_class_procedure;
200SCM_API SCM scm_class_string;
201SCM_API SCM scm_class_symbol;
202SCM_API SCM scm_class_procedure_with_setter;
203SCM_API SCM scm_class_primitive_generic;
204SCM_API SCM scm_class_vector, scm_class_null;
205SCM_API SCM scm_class_real;
206SCM_API SCM scm_class_complex;
207SCM_API SCM scm_class_integer;
208SCM_API SCM scm_class_fraction;
209SCM_API SCM scm_class_unknown;
6290d3f1 210SCM_API SCM scm_port_class[];
04795a1c 211SCM_API SCM scm_smob_class[];
33b001fd
MV		 212SCM_API SCM scm_class_top;
213SCM_API SCM scm_class_object;
214SCM_API SCM scm_class_class;
74b6d6e4 215SCM_API SCM scm_class_applicable;
33b001fd
MV		 216SCM_API SCM scm_class_entity;
217SCM_API SCM scm_class_entity_with_setter;
218SCM_API SCM scm_class_generic;
219SCM_API SCM scm_class_generic_with_setter;
f8af5c6d 220SCM_API SCM scm_class_accessor;
bbf8d523
MD		 221SCM_API SCM scm_class_extended_generic;
222SCM_API SCM scm_class_extended_generic_with_setter;
74b6d6e4 223SCM_API SCM scm_class_extended_accessor;
33b001fd
MV		 224SCM_API SCM scm_class_method;
225SCM_API SCM scm_class_simple_method;
f8af5c6d 226SCM_API SCM scm_class_accessor_method;
33b001fd 227SCM_API SCM scm_class_procedure_class;
33b001fd
MV		 228SCM_API SCM scm_class_entity_class;
229SCM_API SCM scm_class_number;
230SCM_API SCM scm_class_list;
231SCM_API SCM scm_class_keyword;
232SCM_API SCM scm_class_port;
233SCM_API SCM scm_class_input_output_port;
234SCM_API SCM scm_class_input_port;
235SCM_API SCM scm_class_output_port;
236SCM_API SCM scm_class_foreign_class;
237SCM_API SCM scm_class_foreign_object;
238SCM_API SCM scm_class_foreign_slot;
239SCM_API SCM scm_class_self;
240SCM_API SCM scm_class_protected;
b6cf4d02 241SCM_API SCM scm_class_hidden;
33b001fd
MV		 242SCM_API SCM scm_class_opaque;
243SCM_API SCM scm_class_read_only;
b6cf4d02 244SCM_API SCM scm_class_protected_hidden;
33b001fd
MV		 245SCM_API SCM scm_class_protected_opaque;
246SCM_API SCM scm_class_protected_read_only;
247SCM_API SCM scm_class_scm;
248SCM_API SCM scm_class_int;
249SCM_API SCM scm_class_float;
250SCM_API SCM scm_class_double;
251SCM_API const char *scm_s_slot_set_x;
252
539d5410
MV		 253SCM_API SCM scm_no_applicable_method;
254
33b001fd
MV		 255SCM_API SCM scm_module_goops;
256
257SCM_API SCM scm_goops_version (void);
258SCM_API SCM scm_oldfmt (SCM);
259SCM_API char *scm_c_oldfmt0 (char *);
260SCM_API char *scm_c_oldfmt (char *, int n);
261SCM_API void scm_load_goops (void);
efcebb5b
AW		 262SCM_API SCM scm_make_extended_class (char const *type_name, int applicablep);
263SCM_API void scm_make_port_classes (long ptobnum, char *type_name);
33b001fd
MV		 264SCM_API SCM scm_ensure_accessor (SCM name);
265SCM_API void scm_add_method (SCM gf, SCM m);
539d5410 266SCM_API SCM scm_class_of (SCM obj);
0518d3e2
MD		 267
268/* Low level functions exported */
33b001fd
MV		 269SCM_API SCM scm_make_next_method (SCM methods, SCM args, SCM gf);
270SCM_API SCM scm_basic_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
271SCM_API SCM scm_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
0518d3e2
MD		 272
273/* Primitives exported */
33b001fd
MV		 274SCM_API SCM scm_sys_allocate_instance (SCM c, SCM initargs);
275SCM_API SCM scm_sys_set_object_setter_x (SCM obj, SCM setter);
276SCM_API SCM scm_slot_ref (SCM obj, SCM slot_name);
277SCM_API SCM scm_slot_set_x (SCM obj, SCM slot_name, SCM value);
278
279SCM_API SCM scm_compute_applicable_methods (SCM gf, SCM args, long len, int scm_find_method);
280SCM_API SCM scm_sys_compute_applicable_methods (SCM gf, SCM args);
0518d3e2 281#ifdef GUILE_DEBUG
33b001fd 282SCM_API SCM scm_pure_generic_p (SCM obj);
0518d3e2 283#endif
0518d3e2 284
0b607675 285SCM_API SCM scm_sys_compute_slots (SCM c);
efcebb5b 286SCM_INTERNAL void scm_i_inherit_applicable (SCM c);
102dbb6f
LC		 287SCM_INTERNAL SCM scm_i_get_keyword (SCM key, SCM l, long len,
288 SCM default_value, const char *subr);
0b607675
TTN		 289SCM_API SCM scm_get_keyword (SCM key, SCM l, SCM default_value);
290SCM_API SCM scm_sys_initialize_object (SCM obj, SCM initargs);
291SCM_API SCM scm_sys_prep_layout_x (SCM c);
292SCM_API SCM scm_sys_inherit_magic_x (SCM c, SCM dsupers);
293SCM_API SCM scm_instance_p (SCM obj);
294SCM_API SCM scm_class_name (SCM obj);
295SCM_API SCM scm_class_direct_supers (SCM obj);
296SCM_API SCM scm_class_direct_slots (SCM obj);
297SCM_API SCM scm_class_direct_subclasses (SCM obj);
298SCM_API SCM scm_class_direct_methods (SCM obj);
299SCM_API SCM scm_class_precedence_list (SCM obj);
300SCM_API SCM scm_class_slots (SCM obj);
301SCM_API SCM scm_class_environment (SCM obj);
302SCM_API SCM scm_generic_function_name (SCM obj);
303SCM_API SCM scm_generic_function_methods (SCM obj);
304SCM_API SCM scm_method_generic_function (SCM obj);
305SCM_API SCM scm_method_specializers (SCM obj);
306SCM_API SCM scm_method_procedure (SCM obj);
33b001fd
MV		 307SCM_API SCM scm_accessor_method_slot_definition (SCM obj);
308SCM_API SCM scm_sys_tag_body (SCM body);
0b607675
TTN		 309SCM_API SCM scm_sys_fast_slot_ref (SCM obj, SCM index);
310SCM_API SCM scm_sys_fast_slot_set_x (SCM obj, SCM index, SCM value);
311SCM_API SCM scm_slot_ref_using_class (SCM cls, SCM obj, SCM slot_name);
312SCM_API SCM scm_slot_set_using_class_x (SCM cls, SCM obj, SCM slot_name, SCM value);
313SCM_API SCM scm_slot_bound_using_class_p (SCM cls, SCM obj, SCM slot_name);
314SCM_API SCM scm_slot_exists_using_class_p (SCM cls, SCM obj, SCM slot_name);
315SCM_API SCM scm_slot_bound_p (SCM obj, SCM slot_name);
316SCM_API SCM scm_slot_exists_p (SCM obj, SCM slot_name);
317SCM_API SCM scm_sys_modify_instance (SCM old, SCM newinst);
33b001fd
MV		 318SCM_API SCM scm_sys_modify_class (SCM old, SCM newcls);
319SCM_API SCM scm_sys_invalidate_class (SCM cls);
320SCM_API SCM scm_make_method_cache (SCM gf);
321SCM_API SCM scm_sys_invalidate_method_cache_x (SCM gf);
322SCM_API SCM scm_generic_capability_p (SCM proc);
323SCM_API SCM scm_enable_primitive_generic_x (SCM subrs);
324SCM_API SCM scm_primitive_generic_generic (SCM subr);
a48d60b1 325SCM_API void scm_c_extend_primitive_generic (SCM subr, SCM extension);
0b607675
TTN		 326SCM_API SCM stklos_version (void);
327SCM_API SCM scm_make (SCM args);
328SCM_API SCM scm_find_method (SCM args);
329SCM_API SCM scm_sys_method_more_specific_p (SCM m1, SCM m2, SCM targs);
efcebb5b
AW		 330SCM_API void scm_change_object_class (SCM, SCM, SCM);
331SCM_API SCM scm_memoize_method (SCM x, SCM args);
332SCM_API SCM scm_mcache_lookup_cmethod (SCM cache, SCM args);
333SCM_API SCM scm_mcache_compute_cmethod (SCM cache, SCM args);
334/* The following are declared in __scm.h
335SCM_API SCM scm_call_generic_0 (SCM gf);
336SCM_API SCM scm_call_generic_1 (SCM gf, SCM a1);
337SCM_API SCM scm_call_generic_2 (SCM gf, SCM a1, SCM a2);
338SCM_API SCM scm_apply_generic (SCM gf, SCM args);
339*/
340SCM_API SCM scm_call_generic_3 (SCM gf, SCM a1, SCM a2, SCM a3);
341
33b001fd 342
102dbb6f
LC		 343SCM_INTERNAL SCM scm_init_goops_builtins (void);
344SCM_INTERNAL void scm_init_goops (void);
0518d3e2 345
a392ee15
DH		 346#endif /* SCM_GOOPS_H */
347
348/*
349 Local Variables:
350 c-file-style: "gnu"
351 End:
352*/
Unnamed repository; edit this file 'description' to name the repository.