HCoop / bpt / guile.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Changed license terms to the plain LGPL thru-out.
[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 *
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.
a392ee15 12 *
73be1d9e 13 * This library is distributed in the hope that it will be useful,
0518d3e2 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.
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
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
a392ee15 22
0518d3e2
MD		 23\f
24
25/* This software is a derivative work of other copyrighted softwares; the
26 * copyright notices of these softwares are placed in the file COPYRIGHTS
27 *
28 * This file is based upon stklos.h from the STk distribution by
29 * Erick Gallesio <eg@unice.fr>.
30 */
31
32#include "libguile/__scm.h"
33
398d8ee1
KN		 34#include "libguile/validate.h"
35
0518d3e2
MD		 36/*
37 * scm_class_class
38 */
39
7895b092 40#define SCM_CLASS_CLASS_LAYOUT "prsrpwpopopwururururururururpwpwpwpwpwpwpwpwpwpwpwpw"
0518d3e2
MD		 41
42#define scm_si_layout 0 /* the struct layout */
0b607675 43#define scm_si_vtable 1
7895b092
MV		 44#define scm_si_print 2 /* the struct print closure */
45#define scm_si_proc 3
0b607675 46#define scm_si_setter 4
0518d3e2 47
7895b092 48#define scm_si_goops_fields 5
0518d3e2 49
7895b092
MV		 50/* Defined in libguile/objects.h:
51#define scm_si_redefined 5 The class to which class was redefined.
52#define scm_si_hashsets 6
0518d3e2 53*/
7895b092
MV		 54#define scm_si_name 14 /* a symbol */
55#define scm_si_direct_supers 15 /* (class ...) */
56#define scm_si_direct_slots 16 /* ((name . options) ...) */
57#define scm_si_direct_subclasses 17 /* (class ...) */
58#define scm_si_direct_methods 18 /* (methods ...) */
59#define scm_si_cpl 19 /* (class ...) */
0b607675 60#define scm_si_slotdef_class 20
7895b092 61#define scm_si_slots 21 /* ((name . options) ...) */
0b607675
TTN		 62#define scm_si_name_access 22
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
MD		 75
76#define SCM_CLASSF_SIMPLE_METHOD (0x004 << 20)
77#define SCM_CLASSF_ACCESSOR_METHOD (0x008 << 20)
78
79/* Defined in libguile/objects.c */
80/* #define SCM_CLASSF_PURE_GENERIC (0x010 << 20) */
81
82#define SCM_CLASSF_FOREIGN (0x020 << 20)
83#define SCM_CLASSF_METACLASS (0x040 << 20)
84
85/* Defined in libguile/objects.c */
86/* #define SCM_CLASSF_GOOPS_VALID (0x080 << 20) */
87/* #define SCM_CLASSF_GOOPS (0x100 << 20) */
88#define SCM_CLASSF_GOOPS_OR_VALID (SCM_CLASSF_GOOPS | SCM_CLASSF_GOOPS_VALID)
89
90#define SCM_CLASSF_INHERIT (~(SCM_CLASSF_PURE_GENERIC \
91 | SCM_CLASSF_SIMPLE_METHOD \
92 | SCM_CLASSF_ACCESSOR_METHOD \
93 | SCM_STRUCTF_LIGHT) \
94 & SCM_CLASSF_MASK)
95
96#define SCM_INST(x) SCM_STRUCT_DATA (x)
00d8d838
DH		 97
98/* Also defined in libguile/objects.c */
0518d3e2 99#define SCM_CLASS_OF(x) SCM_STRUCT_VTABLE (x)
729dbac3 100#define SCM_ACCESSORS_OF(x) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (x)[scm_si_getters_n_setters]))
00d8d838 101#define SCM_NUMBER_OF_SLOTS(x) \
0518d3e2 102 (SCM_UNPACK (SCM_STRUCT_DATA (x)[scm_struct_i_n_words]) \
00d8d838
DH		 103 - scm_struct_n_extra_words)
104
105#define SCM_CLASSP(x) \
106 (SCM_STRUCTP (x) && SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_METACLASS)
6182ceac 107#define SCM_VALIDATE_CLASS(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, CLASSP, "class")
0518d3e2 108
25ba37df 109#define SCM_INSTANCEP(x) \
00d8d838 110 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_GOOPS))
6182ceac 111#define SCM_VALIDATE_INSTANCE(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, INSTANCEP, "instance")
0518d3e2 112
25ba37df 113#define SCM_PUREGENERICP(x) \
00d8d838 114 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_PURE_GENERIC))
6182ceac 115#define SCM_VALIDATE_PUREGENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, PUREGENERICP, "pure generic function")
e11208ca 116
00d8d838
DH		 117#define SCM_ACCESSORP(x) \
118 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_ACCESSOR_METHOD))
6182ceac 119#define SCM_VALIDATE_ACCESSOR(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, ACCESSORP, "accessor")
0518d3e2 120
729dbac3 121#define SCM_SLOT(x, i) (SCM_PACK (SCM_INST (x) [i]))
dcb410ec 122#define SCM_SET_SLOT(x, i, v) (SCM_INST (x) [i] = SCM_UNPACK (v))
f12745b6 123#define SCM_INSTANCE_HASH(c, i) (SCM_INST (c) [scm_si_hashsets + (i)])
dcb410ec 124#define SCM_SET_HASHSET(c, i, h) (SCM_INST (c) [scm_si_hashsets + (i)] = (h))
00d8d838 125
79a3dafe 126#define SCM_SUBCLASSP(c1, c2) (!SCM_FALSEP (scm_c_memq (c2, SCM_SLOT (c1, scm_si_cpl))))
00d8d838
DH		 127#define SCM_IS_A_P(x, c) \
128 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), c))
0518d3e2 129
00d8d838
DH		 130#define SCM_GENERICP(x) \
131 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_generic))
6182ceac 132#define SCM_VALIDATE_GENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, GENERICP, "generic function")
00d8d838
DH		 133
134#define SCM_METHODP(x) \
135 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_method))
6182ceac 136#define SCM_VALIDATE_METHOD(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, METHODP, "method")
398d8ee1 137
0518d3e2
MD		 138#define SCM_MCACHE_N_SPECIALIZED(C) SCM_CADDR (C)
139#define SCM_SET_MCACHE_N_SPECIALIZED(C, X) SCM_SETCAR (SCM_CDDR (C), X)
140
141#define SCM_INITIAL_MCACHE_SIZE 1
142
143#define scm_si_getters_n_setters scm_si_name_access
144
145#define scm_si_constructor SCM_N_CLASS_SLOTS
146#define scm_si_destructor SCM_N_CLASS_SLOTS + 1
147
148#define scm_si_methods 0 /* offset of methods slot in a <generic> */
149#define scm_si_n_specialized 1
150#define scm_si_used_by 2
151#define scm_si_cache_mutex 3
152
153#define scm_si_generic_function 0 /* offset of gf slot in a <method> */
154#define scm_si_specializers 1 /* offset of spec. slot in a <method> */
155
156#define scm_si_procedure 2 /* offset of proc. slot in a <method> */
157#define scm_si_code_table 3 /* offset of code. slot in a <method> */
158
159/* C interface */
33b001fd
MV		 160SCM_API SCM scm_class_top;
161SCM_API SCM scm_class_object;
162SCM_API SCM scm_class_class;
74b6d6e4 163SCM_API SCM scm_class_applicable;
33b001fd
MV		 164SCM_API SCM scm_class_entity;
165SCM_API SCM scm_class_entity_with_setter;
166SCM_API SCM scm_class_generic;
167SCM_API SCM scm_class_generic_with_setter;
f8af5c6d 168SCM_API SCM scm_class_accessor;
bbf8d523
MD		 169SCM_API SCM scm_class_extended_generic;
170SCM_API SCM scm_class_extended_generic_with_setter;
74b6d6e4 171SCM_API SCM scm_class_extended_accessor;
33b001fd
MV		 172SCM_API SCM scm_class_method;
173SCM_API SCM scm_class_simple_method;
f8af5c6d 174SCM_API SCM scm_class_accessor_method;
33b001fd
MV		 175SCM_API SCM scm_class_procedure_class;
176SCM_API SCM scm_class_operator_class;
177SCM_API SCM scm_class_operator_with_setter_class;
178SCM_API SCM scm_class_entity_class;
179SCM_API SCM scm_class_number;
180SCM_API SCM scm_class_list;
181SCM_API SCM scm_class_keyword;
182SCM_API SCM scm_class_port;
183SCM_API SCM scm_class_input_output_port;
184SCM_API SCM scm_class_input_port;
185SCM_API SCM scm_class_output_port;
186SCM_API SCM scm_class_foreign_class;
187SCM_API SCM scm_class_foreign_object;
188SCM_API SCM scm_class_foreign_slot;
189SCM_API SCM scm_class_self;
190SCM_API SCM scm_class_protected;
191SCM_API SCM scm_class_opaque;
192SCM_API SCM scm_class_read_only;
193SCM_API SCM scm_class_protected_opaque;
194SCM_API SCM scm_class_protected_read_only;
195SCM_API SCM scm_class_scm;
196SCM_API SCM scm_class_int;
197SCM_API SCM scm_class_float;
198SCM_API SCM scm_class_double;
199SCM_API const char *scm_s_slot_set_x;
200
201SCM_API SCM scm_module_goops;
202
203SCM_API SCM scm_goops_version (void);
204SCM_API SCM scm_oldfmt (SCM);
205SCM_API char *scm_c_oldfmt0 (char *);
206SCM_API char *scm_c_oldfmt (char *, int n);
207SCM_API void scm_load_goops (void);
208SCM_API SCM scm_make_foreign_object (SCM cls, SCM initargs);
209SCM_API SCM scm_make_class (SCM meta, char *s_name, SCM supers, size_t size,
210 void * (*constructor) (SCM initargs),
211 size_t (*destructor) (void *));
212SCM_API void scm_add_slot (SCM c, char *slot, SCM slot_class,
213 SCM (*getter) (SCM obj),
214 SCM (*setter) (SCM obj, SCM x),
215 char *accessor_name);
216SCM_API SCM scm_wrap_object (SCM c, void *);
217SCM_API SCM scm_wrap_component (SCM c, SCM obj, void *);
218SCM_API SCM scm_ensure_accessor (SCM name);
219SCM_API void scm_add_method (SCM gf, SCM m);
0518d3e2
MD		 220
221/* Low level functions exported */
33b001fd
MV		 222SCM_API SCM scm_make_next_method (SCM methods, SCM args, SCM gf);
223SCM_API SCM scm_basic_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
224SCM_API SCM scm_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
0518d3e2
MD		 225
226/* Primitives exported */
33b001fd
MV		 227SCM_API SCM scm_sys_allocate_instance (SCM c, SCM initargs);
228SCM_API SCM scm_sys_set_object_setter_x (SCM obj, SCM setter);
229SCM_API SCM scm_slot_ref (SCM obj, SCM slot_name);
230SCM_API SCM scm_slot_set_x (SCM obj, SCM slot_name, SCM value);
231
232SCM_API SCM scm_compute_applicable_methods (SCM gf, SCM args, long len, int scm_find_method);
233SCM_API SCM scm_sys_compute_applicable_methods (SCM gf, SCM args);
234SCM_API SCM scm_m_atslot_ref (SCM xorig, SCM env);
235SCM_API SCM scm_m_atslot_set_x (SCM xorig, SCM env);
236SCM_API SCM scm_m_atdispatch (SCM xorig, SCM env);
0518d3e2 237#ifdef GUILE_DEBUG
33b001fd 238SCM_API SCM scm_pure_generic_p (SCM obj);
0518d3e2 239#endif
0518d3e2 240
0b607675
TTN		 241SCM_API SCM scm_sys_compute_slots (SCM c);
242SCM_API SCM scm_i_get_keyword (SCM key, SCM l, long len, SCM default_value, const char *subr);
243SCM_API SCM scm_get_keyword (SCM key, SCM l, SCM default_value);
244SCM_API SCM scm_sys_initialize_object (SCM obj, SCM initargs);
245SCM_API SCM scm_sys_prep_layout_x (SCM c);
246SCM_API SCM scm_sys_inherit_magic_x (SCM c, SCM dsupers);
247SCM_API SCM scm_instance_p (SCM obj);
248SCM_API SCM scm_class_name (SCM obj);
249SCM_API SCM scm_class_direct_supers (SCM obj);
250SCM_API SCM scm_class_direct_slots (SCM obj);
251SCM_API SCM scm_class_direct_subclasses (SCM obj);
252SCM_API SCM scm_class_direct_methods (SCM obj);
253SCM_API SCM scm_class_precedence_list (SCM obj);
254SCM_API SCM scm_class_slots (SCM obj);
255SCM_API SCM scm_class_environment (SCM obj);
256SCM_API SCM scm_generic_function_name (SCM obj);
257SCM_API SCM scm_generic_function_methods (SCM obj);
258SCM_API SCM scm_method_generic_function (SCM obj);
259SCM_API SCM scm_method_specializers (SCM obj);
260SCM_API SCM scm_method_procedure (SCM obj);
33b001fd
MV		 261SCM_API SCM scm_accessor_method_slot_definition (SCM obj);
262SCM_API SCM scm_sys_tag_body (SCM body);
0b607675
TTN		 263SCM_API SCM scm_sys_fast_slot_ref (SCM obj, SCM index);
264SCM_API SCM scm_sys_fast_slot_set_x (SCM obj, SCM index, SCM value);
265SCM_API SCM scm_slot_ref_using_class (SCM cls, SCM obj, SCM slot_name);
266SCM_API SCM scm_slot_set_using_class_x (SCM cls, SCM obj, SCM slot_name, SCM value);
267SCM_API SCM scm_slot_bound_using_class_p (SCM cls, SCM obj, SCM slot_name);
268SCM_API SCM scm_slot_exists_using_class_p (SCM cls, SCM obj, SCM slot_name);
269SCM_API SCM scm_slot_bound_p (SCM obj, SCM slot_name);
270SCM_API SCM scm_slot_exists_p (SCM obj, SCM slot_name);
271SCM_API SCM scm_sys_modify_instance (SCM old, SCM newinst);
33b001fd
MV		 272SCM_API SCM scm_sys_modify_class (SCM old, SCM newcls);
273SCM_API SCM scm_sys_invalidate_class (SCM cls);
274SCM_API SCM scm_make_method_cache (SCM gf);
275SCM_API SCM scm_sys_invalidate_method_cache_x (SCM gf);
276SCM_API SCM scm_generic_capability_p (SCM proc);
277SCM_API SCM scm_enable_primitive_generic_x (SCM subrs);
278SCM_API SCM scm_primitive_generic_generic (SCM subr);
a48d60b1 279SCM_API void scm_c_extend_primitive_generic (SCM subr, SCM extension);
0b607675
TTN		 280SCM_API SCM stklos_version (void);
281SCM_API SCM scm_make (SCM args);
282SCM_API SCM scm_find_method (SCM args);
283SCM_API SCM scm_sys_method_more_specific_p (SCM m1, SCM m2, SCM targs);
33b001fd
MV		 284
285SCM_API SCM scm_init_goops_builtins (void);
0b607675 286SCM_API void scm_init_goops (void);
0518d3e2 287
6c4493a0 288#if (SCM_ENABLE_DEPRECATED == 1)
00d8d838
DH		 289
290#define SCM_INST_TYPE(x) SCM_OBJ_CLASS_FLAGS (x)
291#define SCM_SIMPLEMETHODP(x) \
292 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_SIMPLE_METHOD))
293#define SCM_FASTMETHODP(x) \
294 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) \
295 & (SCM_CLASSF_ACCESSOR_METHOD \
296 | SCM_CLASSF_SIMPLE_METHOD)))
297
298
299#endif
300
a392ee15
DH		 301#endif /* SCM_GOOPS_H */
302
303/*
304 Local Variables:
305 c-file-style: "gnu"
306 End:
307*/
Unnamed repository; edit this file 'description' to name the repository.