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