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