* session.scm (apropos): Use hash-for-each instead of
[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
bbf8d523 6/* Copyright (C) 1998,1999,2000,2001, 2002, 2003 Free Software Foundation, Inc.
a392ee15 7 *
0518d3e2
MD
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2, or (at your option)
11 * any later version.
a392ee15 12 *
0518d3e2
MD
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
a392ee15 17 *
0518d3e2
MD
18 * You should have received a copy of the GNU General Public License
19 * along with this software; see the file COPYING. If not, write to
20 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
21 * Boston, MA 02111-1307 USA
22 *
23 * As a special exception, the Free Software Foundation gives permission
24 * for additional uses of the text contained in its release of GUILE.
25 *
26 * The exception is that, if you link the GUILE library with other files
27 * to produce an executable, this does not by itself cause the
28 * resulting executable to be covered by the GNU General Public License.
29 * Your use of that executable is in no way restricted on account of
30 * linking the GUILE library code into it.
31 *
32 * This exception does not however invalidate any other reasons why
33 * the executable file might be covered by the GNU General Public License.
34 *
35 * This exception applies only to the code released by the
36 * Free Software Foundation under the name GUILE. If you copy
37 * code from other Free Software Foundation releases into a copy of
38 * GUILE, as the General Public License permits, the exception does
39 * not apply to the code that you add in this way. To avoid misleading
40 * anyone as to the status of such modified files, you must delete
41 * this exception notice from them.
42 *
43 * If you write modifications of your own for GUILE, it is your choice
44 * whether to permit this exception to apply to your modifications.
45 * If you do not wish that, delete this exception notice. */
a392ee15 46
0518d3e2
MD
47\f
48
49/* This software is a derivative work of other copyrighted softwares; the
50 * copyright notices of these softwares are placed in the file COPYRIGHTS
51 *
52 * This file is based upon stklos.h from the STk distribution by
53 * Erick Gallesio <eg@unice.fr>.
54 */
55
56#include "libguile/__scm.h"
57
398d8ee1
KN
58#include "libguile/validate.h"
59
0518d3e2
MD
60/*
61 * scm_class_class
62 */
63
7895b092 64#define SCM_CLASS_CLASS_LAYOUT "prsrpwpopopwururururururururpwpwpwpwpwpwpwpwpwpwpwpw"
0518d3e2
MD
65
66#define scm_si_layout 0 /* the struct layout */
0b607675 67#define scm_si_vtable 1
7895b092
MV
68#define scm_si_print 2 /* the struct print closure */
69#define scm_si_proc 3
0b607675 70#define scm_si_setter 4
0518d3e2 71
7895b092 72#define scm_si_goops_fields 5
0518d3e2 73
7895b092
MV
74/* Defined in libguile/objects.h:
75#define scm_si_redefined 5 The class to which class was redefined.
76#define scm_si_hashsets 6
0518d3e2 77*/
7895b092
MV
78#define scm_si_name 14 /* a symbol */
79#define scm_si_direct_supers 15 /* (class ...) */
80#define scm_si_direct_slots 16 /* ((name . options) ...) */
81#define scm_si_direct_subclasses 17 /* (class ...) */
82#define scm_si_direct_methods 18 /* (methods ...) */
83#define scm_si_cpl 19 /* (class ...) */
0b607675 84#define scm_si_slotdef_class 20
7895b092 85#define scm_si_slots 21 /* ((name . options) ...) */
0b607675
TTN
86#define scm_si_name_access 22
87#define scm_si_keyword_access 23
7895b092
MV
88#define scm_si_nfields 24 /* an integer */
89#define scm_si_environment 25 /* The environment in which class is built */
90#define SCM_N_CLASS_SLOTS 26
0518d3e2 91
92c2555f 92typedef struct scm_t_method {
0518d3e2
MD
93 SCM generic_function;
94 SCM specializers;
95 SCM procedure;
92c2555f 96} scm_t_method;
0518d3e2 97
92c2555f 98#define SCM_METHOD(obj) ((scm_t_method *) SCM_STRUCT_DATA (obj))
0518d3e2
MD
99
100#define SCM_CLASSF_SIMPLE_METHOD (0x004 << 20)
101#define SCM_CLASSF_ACCESSOR_METHOD (0x008 << 20)
102
103/* Defined in libguile/objects.c */
104/* #define SCM_CLASSF_PURE_GENERIC (0x010 << 20) */
105
106#define SCM_CLASSF_FOREIGN (0x020 << 20)
107#define SCM_CLASSF_METACLASS (0x040 << 20)
108
109/* Defined in libguile/objects.c */
110/* #define SCM_CLASSF_GOOPS_VALID (0x080 << 20) */
111/* #define SCM_CLASSF_GOOPS (0x100 << 20) */
112#define SCM_CLASSF_GOOPS_OR_VALID (SCM_CLASSF_GOOPS | SCM_CLASSF_GOOPS_VALID)
113
114#define SCM_CLASSF_INHERIT (~(SCM_CLASSF_PURE_GENERIC \
115 | SCM_CLASSF_SIMPLE_METHOD \
116 | SCM_CLASSF_ACCESSOR_METHOD \
117 | SCM_STRUCTF_LIGHT) \
118 & SCM_CLASSF_MASK)
119
120#define SCM_INST(x) SCM_STRUCT_DATA (x)
00d8d838
DH
121
122/* Also defined in libguile/objects.c */
0518d3e2 123#define SCM_CLASS_OF(x) SCM_STRUCT_VTABLE (x)
729dbac3 124#define SCM_ACCESSORS_OF(x) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (x)[scm_si_getters_n_setters]))
00d8d838 125#define SCM_NUMBER_OF_SLOTS(x) \
0518d3e2 126 (SCM_UNPACK (SCM_STRUCT_DATA (x)[scm_struct_i_n_words]) \
00d8d838
DH
127 - scm_struct_n_extra_words)
128
129#define SCM_CLASSP(x) \
130 (SCM_STRUCTP (x) && SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_METACLASS)
6182ceac 131#define SCM_VALIDATE_CLASS(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, CLASSP, "class")
0518d3e2 132
25ba37df 133#define SCM_INSTANCEP(x) \
00d8d838 134 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_GOOPS))
6182ceac 135#define SCM_VALIDATE_INSTANCE(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, INSTANCEP, "instance")
0518d3e2 136
25ba37df 137#define SCM_PUREGENERICP(x) \
00d8d838 138 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_PURE_GENERIC))
6182ceac 139#define SCM_VALIDATE_PUREGENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, PUREGENERICP, "pure generic function")
e11208ca 140
00d8d838
DH
141#define SCM_ACCESSORP(x) \
142 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_ACCESSOR_METHOD))
6182ceac 143#define SCM_VALIDATE_ACCESSOR(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, ACCESSORP, "accessor")
0518d3e2 144
729dbac3 145#define SCM_SLOT(x, i) (SCM_PACK (SCM_INST (x) [i]))
dcb410ec 146#define SCM_SET_SLOT(x, i, v) (SCM_INST (x) [i] = SCM_UNPACK (v))
f12745b6 147#define SCM_INSTANCE_HASH(c, i) (SCM_INST (c) [scm_si_hashsets + (i)])
dcb410ec 148#define SCM_SET_HASHSET(c, i, h) (SCM_INST (c) [scm_si_hashsets + (i)] = (h))
00d8d838 149
79a3dafe 150#define SCM_SUBCLASSP(c1, c2) (!SCM_FALSEP (scm_c_memq (c2, SCM_SLOT (c1, scm_si_cpl))))
00d8d838
DH
151#define SCM_IS_A_P(x, c) \
152 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), c))
0518d3e2 153
00d8d838
DH
154#define SCM_GENERICP(x) \
155 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_generic))
6182ceac 156#define SCM_VALIDATE_GENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, GENERICP, "generic function")
00d8d838
DH
157
158#define SCM_METHODP(x) \
159 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_method))
6182ceac 160#define SCM_VALIDATE_METHOD(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, METHODP, "method")
398d8ee1 161
0518d3e2
MD
162#define SCM_MCACHE_N_SPECIALIZED(C) SCM_CADDR (C)
163#define SCM_SET_MCACHE_N_SPECIALIZED(C, X) SCM_SETCAR (SCM_CDDR (C), X)
164
165#define SCM_INITIAL_MCACHE_SIZE 1
166
167#define scm_si_getters_n_setters scm_si_name_access
168
169#define scm_si_constructor SCM_N_CLASS_SLOTS
170#define scm_si_destructor SCM_N_CLASS_SLOTS + 1
171
172#define scm_si_methods 0 /* offset of methods slot in a <generic> */
173#define scm_si_n_specialized 1
174#define scm_si_used_by 2
175#define scm_si_cache_mutex 3
176
177#define scm_si_generic_function 0 /* offset of gf slot in a <method> */
178#define scm_si_specializers 1 /* offset of spec. slot in a <method> */
179
180#define scm_si_procedure 2 /* offset of proc. slot in a <method> */
181#define scm_si_code_table 3 /* offset of code. slot in a <method> */
182
183/* C interface */
33b001fd
MV
184SCM_API SCM scm_class_top;
185SCM_API SCM scm_class_object;
186SCM_API SCM scm_class_class;
187SCM_API SCM scm_class_entity;
188SCM_API SCM scm_class_entity_with_setter;
189SCM_API SCM scm_class_generic;
190SCM_API SCM scm_class_generic_with_setter;
bbf8d523
MD
191SCM_API SCM scm_class_extended_generic;
192SCM_API SCM scm_class_extended_generic_with_setter;
33b001fd
MV
193SCM_API SCM scm_class_method;
194SCM_API SCM scm_class_simple_method;
195SCM_API SCM scm_class_accessor;
196SCM_API SCM scm_class_procedure_class;
197SCM_API SCM scm_class_operator_class;
198SCM_API SCM scm_class_operator_with_setter_class;
199SCM_API SCM scm_class_entity_class;
200SCM_API SCM scm_class_number;
201SCM_API SCM scm_class_list;
202SCM_API SCM scm_class_keyword;
203SCM_API SCM scm_class_port;
204SCM_API SCM scm_class_input_output_port;
205SCM_API SCM scm_class_input_port;
206SCM_API SCM scm_class_output_port;
207SCM_API SCM scm_class_foreign_class;
208SCM_API SCM scm_class_foreign_object;
209SCM_API SCM scm_class_foreign_slot;
210SCM_API SCM scm_class_self;
211SCM_API SCM scm_class_protected;
212SCM_API SCM scm_class_opaque;
213SCM_API SCM scm_class_read_only;
214SCM_API SCM scm_class_protected_opaque;
215SCM_API SCM scm_class_protected_read_only;
216SCM_API SCM scm_class_scm;
217SCM_API SCM scm_class_int;
218SCM_API SCM scm_class_float;
219SCM_API SCM scm_class_double;
220SCM_API const char *scm_s_slot_set_x;
221
222SCM_API SCM scm_module_goops;
223
224SCM_API SCM scm_goops_version (void);
225SCM_API SCM scm_oldfmt (SCM);
226SCM_API char *scm_c_oldfmt0 (char *);
227SCM_API char *scm_c_oldfmt (char *, int n);
228SCM_API void scm_load_goops (void);
229SCM_API SCM scm_make_foreign_object (SCM cls, SCM initargs);
230SCM_API SCM scm_make_class (SCM meta, char *s_name, SCM supers, size_t size,
231 void * (*constructor) (SCM initargs),
232 size_t (*destructor) (void *));
233SCM_API void scm_add_slot (SCM c, char *slot, SCM slot_class,
234 SCM (*getter) (SCM obj),
235 SCM (*setter) (SCM obj, SCM x),
236 char *accessor_name);
237SCM_API SCM scm_wrap_object (SCM c, void *);
238SCM_API SCM scm_wrap_component (SCM c, SCM obj, void *);
239SCM_API SCM scm_ensure_accessor (SCM name);
240SCM_API void scm_add_method (SCM gf, SCM m);
0518d3e2
MD
241
242/* Low level functions exported */
33b001fd
MV
243SCM_API SCM scm_make_next_method (SCM methods, SCM args, SCM gf);
244SCM_API SCM scm_basic_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
245SCM_API SCM scm_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
0518d3e2
MD
246
247/* Primitives exported */
33b001fd
MV
248SCM_API SCM scm_sys_allocate_instance (SCM c, SCM initargs);
249SCM_API SCM scm_sys_set_object_setter_x (SCM obj, SCM setter);
250SCM_API SCM scm_slot_ref (SCM obj, SCM slot_name);
251SCM_API SCM scm_slot_set_x (SCM obj, SCM slot_name, SCM value);
252
253SCM_API SCM scm_compute_applicable_methods (SCM gf, SCM args, long len, int scm_find_method);
254SCM_API SCM scm_sys_compute_applicable_methods (SCM gf, SCM args);
255SCM_API SCM scm_m_atslot_ref (SCM xorig, SCM env);
256SCM_API SCM scm_m_atslot_set_x (SCM xorig, SCM env);
257SCM_API SCM scm_m_atdispatch (SCM xorig, SCM env);
0518d3e2 258#ifdef GUILE_DEBUG
33b001fd 259SCM_API SCM scm_pure_generic_p (SCM obj);
0518d3e2 260#endif
0518d3e2 261
0b607675
TTN
262SCM_API SCM scm_sys_compute_slots (SCM c);
263SCM_API SCM scm_i_get_keyword (SCM key, SCM l, long len, SCM default_value, const char *subr);
264SCM_API SCM scm_get_keyword (SCM key, SCM l, SCM default_value);
265SCM_API SCM scm_sys_initialize_object (SCM obj, SCM initargs);
266SCM_API SCM scm_sys_prep_layout_x (SCM c);
267SCM_API SCM scm_sys_inherit_magic_x (SCM c, SCM dsupers);
268SCM_API SCM scm_instance_p (SCM obj);
269SCM_API SCM scm_class_name (SCM obj);
270SCM_API SCM scm_class_direct_supers (SCM obj);
271SCM_API SCM scm_class_direct_slots (SCM obj);
272SCM_API SCM scm_class_direct_subclasses (SCM obj);
273SCM_API SCM scm_class_direct_methods (SCM obj);
274SCM_API SCM scm_class_precedence_list (SCM obj);
275SCM_API SCM scm_class_slots (SCM obj);
276SCM_API SCM scm_class_environment (SCM obj);
277SCM_API SCM scm_generic_function_name (SCM obj);
278SCM_API SCM scm_generic_function_methods (SCM obj);
279SCM_API SCM scm_method_generic_function (SCM obj);
280SCM_API SCM scm_method_specializers (SCM obj);
281SCM_API SCM scm_method_procedure (SCM obj);
33b001fd
MV
282SCM_API SCM scm_accessor_method_slot_definition (SCM obj);
283SCM_API SCM scm_sys_tag_body (SCM body);
0b607675
TTN
284SCM_API SCM scm_sys_fast_slot_ref (SCM obj, SCM index);
285SCM_API SCM scm_sys_fast_slot_set_x (SCM obj, SCM index, SCM value);
286SCM_API SCM scm_slot_ref_using_class (SCM cls, SCM obj, SCM slot_name);
287SCM_API SCM scm_slot_set_using_class_x (SCM cls, SCM obj, SCM slot_name, SCM value);
288SCM_API SCM scm_slot_bound_using_class_p (SCM cls, SCM obj, SCM slot_name);
289SCM_API SCM scm_slot_exists_using_class_p (SCM cls, SCM obj, SCM slot_name);
290SCM_API SCM scm_slot_bound_p (SCM obj, SCM slot_name);
291SCM_API SCM scm_slot_exists_p (SCM obj, SCM slot_name);
292SCM_API SCM scm_sys_modify_instance (SCM old, SCM newinst);
33b001fd
MV
293SCM_API SCM scm_sys_modify_class (SCM old, SCM newcls);
294SCM_API SCM scm_sys_invalidate_class (SCM cls);
295SCM_API SCM scm_make_method_cache (SCM gf);
296SCM_API SCM scm_sys_invalidate_method_cache_x (SCM gf);
297SCM_API SCM scm_generic_capability_p (SCM proc);
298SCM_API SCM scm_enable_primitive_generic_x (SCM subrs);
299SCM_API SCM scm_primitive_generic_generic (SCM subr);
0b607675
TTN
300SCM_API SCM stklos_version (void);
301SCM_API SCM scm_make (SCM args);
302SCM_API SCM scm_find_method (SCM args);
303SCM_API SCM scm_sys_method_more_specific_p (SCM m1, SCM m2, SCM targs);
33b001fd
MV
304
305SCM_API SCM scm_init_goops_builtins (void);
0b607675 306SCM_API void scm_init_goops (void);
0518d3e2 307
6c4493a0 308#if (SCM_ENABLE_DEPRECATED == 1)
00d8d838
DH
309
310#define SCM_INST_TYPE(x) SCM_OBJ_CLASS_FLAGS (x)
311#define SCM_SIMPLEMETHODP(x) \
312 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_SIMPLE_METHOD))
313#define SCM_FASTMETHODP(x) \
314 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) \
315 & (SCM_CLASSF_ACCESSOR_METHOD \
316 | SCM_CLASSF_SIMPLE_METHOD)))
317
318
319#endif
320
a392ee15
DH
321#endif /* SCM_GOOPS_H */
322
323/*
324 Local Variables:
325 c-file-style: "gnu"
326 End:
327*/