HCoop / bpt / guile.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
fold objects.[ch] into goops.[ch]
[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
0518d3e2
MD		 37/*
38 * scm_class_class
39 */
40
7895b092 41#define SCM_CLASS_CLASS_LAYOUT "prsrpwpopopwururururururururpwpwpwpwpwpwpwpwpwpwpwpw"
0518d3e2
MD		 42
43#define scm_si_layout 0 /* the struct layout */
0b607675 44#define scm_si_vtable 1
7895b092
MV		 45#define scm_si_print 2 /* the struct print closure */
46#define scm_si_proc 3
0b607675 47#define scm_si_setter 4
0518d3e2 48
7895b092 49#define scm_si_goops_fields 5
efcebb5b 50#define scm_si_redefined 5 /* The class to which class was redefined. */
7895b092 51#define scm_si_hashsets 6
efcebb5b 52
7895b092
MV		 53#define scm_si_name 14 /* a symbol */
54#define scm_si_direct_supers 15 /* (class ...) */
55#define scm_si_direct_slots 16 /* ((name . options) ...) */
56#define scm_si_direct_subclasses 17 /* (class ...) */
57#define scm_si_direct_methods 18 /* (methods ...) */
58#define scm_si_cpl 19 /* (class ...) */
0b607675 59#define scm_si_slotdef_class 20
7895b092 60#define scm_si_slots 21 /* ((name . options) ...) */
0b607675 61#define scm_si_name_access 22
efcebb5b 62#define scm_si_getters_n_setters scm_si_name_access
0b607675 63#define scm_si_keyword_access 23
7895b092
MV		 64#define scm_si_nfields 24 /* an integer */
65#define scm_si_environment 25 /* The environment in which class is built */
66#define SCM_N_CLASS_SLOTS 26
0518d3e2 67
92c2555f 68typedef struct scm_t_method {
0518d3e2
MD		 69 SCM generic_function;
70 SCM specializers;
71 SCM procedure;
92c2555f 72} scm_t_method;
0518d3e2 73
92c2555f 74#define SCM_METHOD(obj) ((scm_t_method *) SCM_STRUCT_DATA (obj))
0518d3e2 75
efcebb5b
AW		 76/* {Class flags}
77 *
78 * These are used for efficient identification of instances of a
79 * certain class or its subclasses when traversal of the inheritance
80 * graph would be too costly.
81 */
82#define SCM_CLASS_FLAGS(class) (SCM_STRUCT_DATA (class) [scm_struct_i_flags])
83#define SCM_OBJ_CLASS_FLAGS(obj) (SCM_STRUCT_VTABLE_DATA (obj) [scm_struct_i_flags])
84#define SCM_SET_CLASS_FLAGS(c, f) (SCM_CLASS_FLAGS (c) |= (f))
85#define SCM_CLEAR_CLASS_FLAGS(c, f) (SCM_CLASS_FLAGS (c) &= ~(f))
86#define SCM_CLASSF_MASK SCM_STRUCTF_MASK
87
0518d3e2
MD		 88#define SCM_CLASSF_SIMPLE_METHOD (0x004 << 20)
89#define SCM_CLASSF_ACCESSOR_METHOD (0x008 << 20)
efcebb5b 90#define SCM_CLASSF_PURE_GENERIC SCM_STRUCTF_GOOPS_HACK
0518d3e2
MD		 91#define SCM_CLASSF_FOREIGN (0x020 << 20)
92#define SCM_CLASSF_METACLASS (0x040 << 20)
efcebb5b
AW		 93#define SCM_CLASSF_GOOPS_VALID (0x080 << 20)
94#define SCM_CLASSF_GOOPS (0x100 << 20)
0518d3e2
MD		 95#define SCM_CLASSF_GOOPS_OR_VALID (SCM_CLASSF_GOOPS | SCM_CLASSF_GOOPS_VALID)
96
97#define SCM_CLASSF_INHERIT (~(SCM_CLASSF_PURE_GENERIC \
98 | SCM_CLASSF_SIMPLE_METHOD \
99 | SCM_CLASSF_ACCESSOR_METHOD \
100 | SCM_STRUCTF_LIGHT) \
101 & SCM_CLASSF_MASK)
102
efcebb5b
AW		 103#define SCM_CLASS_OF(x) SCM_STRUCT_VTABLE (x)
104#define SCM_OBJ_CLASS_REDEF(x) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (x) [scm_si_redefined]))
0518d3e2 105#define SCM_INST(x) SCM_STRUCT_DATA (x)
00d8d838 106
0518d3e2 107#define SCM_CLASS_OF(x) SCM_STRUCT_VTABLE (x)
729dbac3 108#define SCM_ACCESSORS_OF(x) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (x)[scm_si_getters_n_setters]))
00d8d838
DH		 109
110#define SCM_CLASSP(x) \
111 (SCM_STRUCTP (x) && SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_METACLASS)
6182ceac 112#define SCM_VALIDATE_CLASS(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, CLASSP, "class")
0518d3e2 113
25ba37df 114#define SCM_INSTANCEP(x) \
00d8d838 115 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_GOOPS))
6182ceac 116#define SCM_VALIDATE_INSTANCE(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, INSTANCEP, "instance")
0518d3e2 117
25ba37df 118#define SCM_PUREGENERICP(x) \
00d8d838 119 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_PURE_GENERIC))
6182ceac 120#define SCM_VALIDATE_PUREGENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, PUREGENERICP, "pure generic function")
e11208ca 121
00d8d838
DH		 122#define SCM_ACCESSORP(x) \
123 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_ACCESSOR_METHOD))
6182ceac 124#define SCM_VALIDATE_ACCESSOR(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, ACCESSORP, "accessor")
0518d3e2 125
729dbac3 126#define SCM_SLOT(x, i) (SCM_PACK (SCM_INST (x) [i]))
dcb410ec 127#define SCM_SET_SLOT(x, i, v) (SCM_INST (x) [i] = SCM_UNPACK (v))
f12745b6 128#define SCM_INSTANCE_HASH(c, i) (SCM_INST (c) [scm_si_hashsets + (i)])
dcb410ec 129#define SCM_SET_HASHSET(c, i, h) (SCM_INST (c) [scm_si_hashsets + (i)] = (h))
00d8d838 130
7888309b 131#define SCM_SUBCLASSP(c1, c2) (scm_is_true (scm_c_memq (c2, SCM_SLOT (c1, scm_si_cpl))))
00d8d838
DH		 132#define SCM_IS_A_P(x, c) \
133 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), c))
0518d3e2 134
00d8d838
DH		 135#define SCM_GENERICP(x) \
136 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_generic))
6182ceac 137#define SCM_VALIDATE_GENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, GENERICP, "generic function")
00d8d838
DH		 138
139#define SCM_METHODP(x) \
140 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_method))
6182ceac 141#define SCM_VALIDATE_METHOD(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, METHODP, "method")
398d8ee1 142
efcebb5b
AW		 143#define SCM_SET_CLASS_DESTRUCTOR(c, d) SCM_SET_VTABLE_DESTRUCTOR (c, d)
144#define SCM_SET_CLASS_INSTANCE_SIZE(c, s) \
145 (SCM_STRUCT_DATA (c)[scm_struct_i_size] \
146 = (SCM_STRUCT_DATA (c) [scm_struct_i_size] & SCM_STRUCTF_MASK) | s)
147
521ac49b
AW		 148#define SCM_GENERIC_METHOD_CACHE(G) (SCM_PACK (SCM_STRUCT_DATA (G) [scm_struct_i_procedure]))
149#define SCM_SET_GENERIC_METHOD_CACHE(G,C) (SCM_STRUCT_DATA (G) [scm_struct_i_procedure] = SCM_UNPACK (C))
11561496
AW		 150#define SCM_GENERIC_SETTER(G) (SCM_PACK (SCM_STRUCT_DATA (G) [scm_struct_i_setter]))
151#define SCM_SET_GENERIC_SETTER(G,C) (SCM_STRUCT_DATA (G) [scm_struct_i_setter] = SCM_UNPACK (C))
0518d3e2
MD		 152#define SCM_MCACHE_N_SPECIALIZED(C) SCM_CADDR (C)
153#define SCM_SET_MCACHE_N_SPECIALIZED(C, X) SCM_SETCAR (SCM_CDDR (C), X)
154
155#define SCM_INITIAL_MCACHE_SIZE 1
156
0518d3e2
MD		 157#define scm_si_constructor SCM_N_CLASS_SLOTS
158#define scm_si_destructor SCM_N_CLASS_SLOTS + 1
159
160#define scm_si_methods 0 /* offset of methods slot in a <generic> */
161#define scm_si_n_specialized 1
162#define scm_si_used_by 2
163#define scm_si_cache_mutex 3
164
165#define scm_si_generic_function 0 /* offset of gf slot in a <method> */
166#define scm_si_specializers 1 /* offset of spec. slot in a <method> */
0518d3e2
MD		 167#define scm_si_procedure 2 /* offset of proc. slot in a <method> */
168#define scm_si_code_table 3 /* offset of code. slot in a <method> */
21497600
AW		 169#define scm_si_formals 4 /* offset of form. slot in a <method> */
170#define scm_si_body 5 /* offset of body slot in a <method> */
e177058b 171#define scm_si_make_procedure 6 /* offset of makep.slot in a <method> */
0518d3e2
MD		 172
173/* C interface */
539d5410
MV		 174SCM_API SCM scm_class_boolean;
175SCM_API SCM scm_class_char;
176SCM_API SCM scm_class_pair;
177SCM_API SCM scm_class_procedure;
178SCM_API SCM scm_class_string;
179SCM_API SCM scm_class_symbol;
180SCM_API SCM scm_class_procedure_with_setter;
181SCM_API SCM scm_class_primitive_generic;
182SCM_API SCM scm_class_vector, scm_class_null;
183SCM_API SCM scm_class_real;
184SCM_API SCM scm_class_complex;
185SCM_API SCM scm_class_integer;
186SCM_API SCM scm_class_fraction;
187SCM_API SCM scm_class_unknown;
6290d3f1 188SCM_API SCM scm_port_class[];
04795a1c 189SCM_API SCM scm_smob_class[];
33b001fd
MV		 190SCM_API SCM scm_class_top;
191SCM_API SCM scm_class_object;
192SCM_API SCM scm_class_class;
74b6d6e4 193SCM_API SCM scm_class_applicable;
33b001fd
MV		 194SCM_API SCM scm_class_entity;
195SCM_API SCM scm_class_entity_with_setter;
196SCM_API SCM scm_class_generic;
197SCM_API SCM scm_class_generic_with_setter;
f8af5c6d 198SCM_API SCM scm_class_accessor;
bbf8d523
MD		 199SCM_API SCM scm_class_extended_generic;
200SCM_API SCM scm_class_extended_generic_with_setter;
74b6d6e4 201SCM_API SCM scm_class_extended_accessor;
33b001fd
MV		 202SCM_API SCM scm_class_method;
203SCM_API SCM scm_class_simple_method;
f8af5c6d 204SCM_API SCM scm_class_accessor_method;
33b001fd 205SCM_API SCM scm_class_procedure_class;
33b001fd
MV		 206SCM_API SCM scm_class_entity_class;
207SCM_API SCM scm_class_number;
208SCM_API SCM scm_class_list;
209SCM_API SCM scm_class_keyword;
210SCM_API SCM scm_class_port;
211SCM_API SCM scm_class_input_output_port;
212SCM_API SCM scm_class_input_port;
213SCM_API SCM scm_class_output_port;
214SCM_API SCM scm_class_foreign_class;
215SCM_API SCM scm_class_foreign_object;
216SCM_API SCM scm_class_foreign_slot;
217SCM_API SCM scm_class_self;
218SCM_API SCM scm_class_protected;
219SCM_API SCM scm_class_opaque;
220SCM_API SCM scm_class_read_only;
221SCM_API SCM scm_class_protected_opaque;
222SCM_API SCM scm_class_protected_read_only;
223SCM_API SCM scm_class_scm;
224SCM_API SCM scm_class_int;
225SCM_API SCM scm_class_float;
226SCM_API SCM scm_class_double;
227SCM_API const char *scm_s_slot_set_x;
228
539d5410
MV		 229SCM_API SCM scm_no_applicable_method;
230
33b001fd
MV		 231SCM_API SCM scm_module_goops;
232
233SCM_API SCM scm_goops_version (void);
234SCM_API SCM scm_oldfmt (SCM);
235SCM_API char *scm_c_oldfmt0 (char *);
236SCM_API char *scm_c_oldfmt (char *, int n);
237SCM_API void scm_load_goops (void);
238SCM_API SCM scm_make_foreign_object (SCM cls, SCM initargs);
239SCM_API SCM scm_make_class (SCM meta, char *s_name, SCM supers, size_t size,
240 void * (*constructor) (SCM initargs),
241 size_t (*destructor) (void *));
efcebb5b
AW		 242SCM_API SCM scm_make_extended_class (char const *type_name, int applicablep);
243SCM_API void scm_make_port_classes (long ptobnum, char *type_name);
33b001fd
MV		 244SCM_API void scm_add_slot (SCM c, char *slot, SCM slot_class,
245 SCM (*getter) (SCM obj),
246 SCM (*setter) (SCM obj, SCM x),
247 char *accessor_name);
248SCM_API SCM scm_wrap_object (SCM c, void *);
249SCM_API SCM scm_wrap_component (SCM c, SCM obj, void *);
250SCM_API SCM scm_ensure_accessor (SCM name);
251SCM_API void scm_add_method (SCM gf, SCM m);
539d5410 252SCM_API SCM scm_class_of (SCM obj);
0518d3e2
MD		 253
254/* Low level functions exported */
33b001fd
MV		 255SCM_API SCM scm_make_next_method (SCM methods, SCM args, SCM gf);
256SCM_API SCM scm_basic_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
257SCM_API SCM scm_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
0518d3e2
MD		 258
259/* Primitives exported */
33b001fd
MV		 260SCM_API SCM scm_sys_allocate_instance (SCM c, SCM initargs);
261SCM_API SCM scm_sys_set_object_setter_x (SCM obj, SCM setter);
262SCM_API SCM scm_slot_ref (SCM obj, SCM slot_name);
263SCM_API SCM scm_slot_set_x (SCM obj, SCM slot_name, SCM value);
264
265SCM_API SCM scm_compute_applicable_methods (SCM gf, SCM args, long len, int scm_find_method);
266SCM_API SCM scm_sys_compute_applicable_methods (SCM gf, SCM args);
0518d3e2 267#ifdef GUILE_DEBUG
33b001fd 268SCM_API SCM scm_pure_generic_p (SCM obj);
0518d3e2 269#endif
0518d3e2 270
0b607675 271SCM_API SCM scm_sys_compute_slots (SCM c);
efcebb5b 272SCM_INTERNAL void scm_i_inherit_applicable (SCM c);
102dbb6f
LC		 273SCM_INTERNAL SCM scm_i_get_keyword (SCM key, SCM l, long len,
274 SCM default_value, const char *subr);
0b607675
TTN		 275SCM_API SCM scm_get_keyword (SCM key, SCM l, SCM default_value);
276SCM_API SCM scm_sys_initialize_object (SCM obj, SCM initargs);
277SCM_API SCM scm_sys_prep_layout_x (SCM c);
278SCM_API SCM scm_sys_inherit_magic_x (SCM c, SCM dsupers);
279SCM_API SCM scm_instance_p (SCM obj);
280SCM_API SCM scm_class_name (SCM obj);
281SCM_API SCM scm_class_direct_supers (SCM obj);
282SCM_API SCM scm_class_direct_slots (SCM obj);
283SCM_API SCM scm_class_direct_subclasses (SCM obj);
284SCM_API SCM scm_class_direct_methods (SCM obj);
285SCM_API SCM scm_class_precedence_list (SCM obj);
286SCM_API SCM scm_class_slots (SCM obj);
287SCM_API SCM scm_class_environment (SCM obj);
288SCM_API SCM scm_generic_function_name (SCM obj);
289SCM_API SCM scm_generic_function_methods (SCM obj);
290SCM_API SCM scm_method_generic_function (SCM obj);
291SCM_API SCM scm_method_specializers (SCM obj);
292SCM_API SCM scm_method_procedure (SCM obj);
33b001fd
MV		 293SCM_API SCM scm_accessor_method_slot_definition (SCM obj);
294SCM_API SCM scm_sys_tag_body (SCM body);
0b607675
TTN		 295SCM_API SCM scm_sys_fast_slot_ref (SCM obj, SCM index);
296SCM_API SCM scm_sys_fast_slot_set_x (SCM obj, SCM index, SCM value);
297SCM_API SCM scm_slot_ref_using_class (SCM cls, SCM obj, SCM slot_name);
298SCM_API SCM scm_slot_set_using_class_x (SCM cls, SCM obj, SCM slot_name, SCM value);
299SCM_API SCM scm_slot_bound_using_class_p (SCM cls, SCM obj, SCM slot_name);
300SCM_API SCM scm_slot_exists_using_class_p (SCM cls, SCM obj, SCM slot_name);
301SCM_API SCM scm_slot_bound_p (SCM obj, SCM slot_name);
302SCM_API SCM scm_slot_exists_p (SCM obj, SCM slot_name);
303SCM_API SCM scm_sys_modify_instance (SCM old, SCM newinst);
33b001fd
MV		 304SCM_API SCM scm_sys_modify_class (SCM old, SCM newcls);
305SCM_API SCM scm_sys_invalidate_class (SCM cls);
306SCM_API SCM scm_make_method_cache (SCM gf);
307SCM_API SCM scm_sys_invalidate_method_cache_x (SCM gf);
308SCM_API SCM scm_generic_capability_p (SCM proc);
309SCM_API SCM scm_enable_primitive_generic_x (SCM subrs);
310SCM_API SCM scm_primitive_generic_generic (SCM subr);
a48d60b1 311SCM_API void scm_c_extend_primitive_generic (SCM subr, SCM extension);
0b607675
TTN		 312SCM_API SCM stklos_version (void);
313SCM_API SCM scm_make (SCM args);
314SCM_API SCM scm_find_method (SCM args);
315SCM_API SCM scm_sys_method_more_specific_p (SCM m1, SCM m2, SCM targs);
efcebb5b
AW		 316SCM_API void scm_change_object_class (SCM, SCM, SCM);
317SCM_API SCM scm_memoize_method (SCM x, SCM args);
318SCM_API SCM scm_mcache_lookup_cmethod (SCM cache, SCM args);
319SCM_API SCM scm_mcache_compute_cmethod (SCM cache, SCM args);
320/* The following are declared in __scm.h
321SCM_API SCM scm_call_generic_0 (SCM gf);
322SCM_API SCM scm_call_generic_1 (SCM gf, SCM a1);
323SCM_API SCM scm_call_generic_2 (SCM gf, SCM a1, SCM a2);
324SCM_API SCM scm_apply_generic (SCM gf, SCM args);
325*/
326SCM_API SCM scm_call_generic_3 (SCM gf, SCM a1, SCM a2, SCM a3);
327
33b001fd 328
102dbb6f
LC		 329SCM_INTERNAL SCM scm_init_goops_builtins (void);
330SCM_INTERNAL void scm_init_goops (void);
0518d3e2 331
6c4493a0 332#if (SCM_ENABLE_DEPRECATED == 1)
00d8d838
DH		 333
334#define SCM_INST_TYPE(x) SCM_OBJ_CLASS_FLAGS (x)
335#define SCM_SIMPLEMETHODP(x) \
336 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_SIMPLE_METHOD))
337#define SCM_FASTMETHODP(x) \
338 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) \
339 & (SCM_CLASSF_ACCESSOR_METHOD \
340 | SCM_CLASSF_SIMPLE_METHOD)))
341
342
343#endif
344
a392ee15
DH		 345#endif /* SCM_GOOPS_H */
346
347/*
348 Local Variables:
349 c-file-style: "gnu"
350 End:
351*/
Unnamed repository; edit this file 'description' to name the repository.