1 /* classes: h_files */ 2 3 #ifndef SCM_GOOPS_H 4 #define SCM_GOOPS_H 5 6 /* Copyright (C) 1998,1999,2000,2001,2002,2003, 2006 Free Software Foundation, Inc. 7 * 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. 12 * 13 * This library 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 GNU 16 * Lesser General Public License for more details. 17 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 21 */ 22 23 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 34 #include "libguile/validate.h" 35 36 /* 37 * scm_class_class 38 */ 39 40 #define SCM_CLASS_CLASS_LAYOUT "prsrpwpopopwururururururururpwpwpwpwpwpwpwpwpwpwpwpw" 41 42 #define scm_si_layout 0 /* the struct layout */ 43 #define scm_si_vtable 1 44 #define scm_si_print 2 /* the struct print closure */ 45 #define scm_si_proc 3 46 #define scm_si_setter 4 47 48 #define scm_si_goops_fields 5 49 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 53 */ 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 ...) */ 60 #define scm_si_slotdef_class 20 61 #define scm_si_slots 21 /* ((name . options) ...) */ 62 #define scm_si_name_access 22 63 #define scm_si_keyword_access 23 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 67 68 typedef struct scm_t_method { 69 SCM generic_function; 70 SCM specializers; 71 SCM procedure; 72 } scm_t_method; 73 74 #define SCM_METHOD(obj) ((scm_t_method *) SCM_STRUCT_DATA (obj)) 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) 97 98 /* Also defined in libguile/objects.c */ 99 #define SCM_CLASS_OF(x) SCM_STRUCT_VTABLE (x) 100 #define SCM_ACCESSORS_OF(x) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (x)[scm_si_getters_n_setters])) 101 102 #define SCM_CLASSP(x) \ 103 (SCM_STRUCTP (x) && SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_METACLASS) 104 #define SCM_VALIDATE_CLASS(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, CLASSP, "class") 105 106 #define SCM_INSTANCEP(x) \ 107 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_GOOPS)) 108 #define SCM_VALIDATE_INSTANCE(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, INSTANCEP, "instance") 109 110 #define SCM_PUREGENERICP(x) \ 111 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_PURE_GENERIC)) 112 #define SCM_VALIDATE_PUREGENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, PUREGENERICP, "pure generic function") 113 114 #define SCM_ACCESSORP(x) \ 115 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_ACCESSOR_METHOD)) 116 #define SCM_VALIDATE_ACCESSOR(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, ACCESSORP, "accessor") 117 118 #define SCM_SLOT(x, i) (SCM_PACK (SCM_INST (x) [i])) 119 #define SCM_SET_SLOT(x, i, v) (SCM_INST (x) [i] = SCM_UNPACK (v)) 120 #define SCM_INSTANCE_HASH(c, i) (SCM_INST (c) [scm_si_hashsets + (i)]) 121 #define SCM_SET_HASHSET(c, i, h) (SCM_INST (c) [scm_si_hashsets + (i)] = (h)) 122 123 #define SCM_SUBCLASSP(c1, c2) (scm_is_true (scm_c_memq (c2, SCM_SLOT (c1, scm_si_cpl)))) 124 #define SCM_IS_A_P(x, c) \ 125 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), c)) 126 127 #define SCM_GENERICP(x) \ 128 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_generic)) 129 #define SCM_VALIDATE_GENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, GENERICP, "generic function") 130 131 #define SCM_METHODP(x) \ 132 (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_method)) 133 #define SCM_VALIDATE_METHOD(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, METHODP, "method") 134 135 #define SCM_MCACHE_N_SPECIALIZED(C) SCM_CADDR (C) 136 #define SCM_SET_MCACHE_N_SPECIALIZED(C, X) SCM_SETCAR (SCM_CDDR (C), X) 137 138 #define SCM_INITIAL_MCACHE_SIZE 1 139 140 #define scm_si_getters_n_setters scm_si_name_access 141 142 #define scm_si_constructor SCM_N_CLASS_SLOTS 143 #define scm_si_destructor SCM_N_CLASS_SLOTS + 1 144 145 #define scm_si_methods 0 /* offset of methods slot in a <generic> */ 146 #define scm_si_n_specialized 1 147 #define scm_si_used_by 2 148 #define scm_si_cache_mutex 3 149 150 #define scm_si_generic_function 0 /* offset of gf slot in a <method> */ 151 #define scm_si_specializers 1 /* offset of spec. slot in a <method> */ 152 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> */ 155 156 /* C interface */ 157 SCM_API SCM scm_class_boolean; 158 SCM_API SCM scm_class_char; 159 SCM_API SCM scm_class_pair; 160 SCM_API SCM scm_class_procedure; 161 SCM_API SCM scm_class_string; 162 SCM_API SCM scm_class_symbol; 163 SCM_API SCM scm_class_procedure_with_setter; 164 SCM_API SCM scm_class_primitive_generic; 165 SCM_API SCM scm_class_vector, scm_class_null; 166 SCM_API SCM scm_class_real; 167 SCM_API SCM scm_class_complex; 168 SCM_API SCM scm_class_integer; 169 SCM_API SCM scm_class_fraction; 170 SCM_API SCM scm_class_unknown; 171 SCM_API SCM *scm_port_class; 172 SCM_API SCM *scm_smob_class; 173 SCM_API SCM scm_class_top; 174 SCM_API SCM scm_class_object; 175 SCM_API SCM scm_class_class; 176 SCM_API SCM scm_class_applicable; 177 SCM_API SCM scm_class_entity; 178 SCM_API SCM scm_class_entity_with_setter; 179 SCM_API SCM scm_class_generic; 180 SCM_API SCM scm_class_generic_with_setter; 181 SCM_API SCM scm_class_accessor; 182 SCM_API SCM scm_class_extended_generic; 183 SCM_API SCM scm_class_extended_generic_with_setter; 184 SCM_API SCM scm_class_extended_accessor; 185 SCM_API SCM scm_class_method; 186 SCM_API SCM scm_class_simple_method; 187 SCM_API SCM scm_class_accessor_method; 188 SCM_API SCM scm_class_procedure_class; 189 SCM_API SCM scm_class_operator_class; 190 SCM_API SCM scm_class_operator_with_setter_class; 191 SCM_API SCM scm_class_entity_class; 192 SCM_API SCM scm_class_number; 193 SCM_API SCM scm_class_list; 194 SCM_API SCM scm_class_keyword; 195 SCM_API SCM scm_class_port; 196 SCM_API SCM scm_class_input_output_port; 197 SCM_API SCM scm_class_input_port; 198 SCM_API SCM scm_class_output_port; 199 SCM_API SCM scm_class_foreign_class; 200 SCM_API SCM scm_class_foreign_object; 201 SCM_API SCM scm_class_foreign_slot; 202 SCM_API SCM scm_class_self; 203 SCM_API SCM scm_class_protected; 204 SCM_API SCM scm_class_opaque; 205 SCM_API SCM scm_class_read_only; 206 SCM_API SCM scm_class_protected_opaque; 207 SCM_API SCM scm_class_protected_read_only; 208 SCM_API SCM scm_class_scm; 209 SCM_API SCM scm_class_int; 210 SCM_API SCM scm_class_float; 211 SCM_API SCM scm_class_double; 212 SCM_API const char *scm_s_slot_set_x; 213 214 SCM_API SCM scm_no_applicable_method; 215 216 SCM_API SCM scm_module_goops; 217 218 SCM_API SCM scm_goops_version (void); 219 SCM_API SCM scm_oldfmt (SCM); 220 SCM_API char *scm_c_oldfmt0 (char *); 221 SCM_API char *scm_c_oldfmt (char *, int n); 222 SCM_API void scm_load_goops (void); 223 SCM_API SCM scm_make_foreign_object (SCM cls, SCM initargs); 224 SCM_API SCM scm_make_class (SCM meta, char *s_name, SCM supers, size_t size, 225 void * (*constructor) (SCM initargs), 226 size_t (*destructor) (void *)); 227 SCM_API void scm_add_slot (SCM c, char *slot, SCM slot_class, 228 SCM (*getter) (SCM obj), 229 SCM (*setter) (SCM obj, SCM x), 230 char *accessor_name); 231 SCM_API SCM scm_wrap_object (SCM c, void *); 232 SCM_API SCM scm_wrap_component (SCM c, SCM obj, void *); 233 SCM_API SCM scm_ensure_accessor (SCM name); 234 SCM_API void scm_add_method (SCM gf, SCM m); 235 SCM_API SCM scm_class_of (SCM obj); 236 237 /* Low level functions exported */ 238 SCM_API SCM scm_make_next_method (SCM methods, SCM args, SCM gf); 239 SCM_API SCM scm_basic_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots); 240 SCM_API SCM scm_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots); 241 242 /* Primitives exported */ 243 SCM_API SCM scm_sys_allocate_instance (SCM c, SCM initargs); 244 SCM_API SCM scm_sys_set_object_setter_x (SCM obj, SCM setter); 245 SCM_API SCM scm_slot_ref (SCM obj, SCM slot_name); 246 SCM_API SCM scm_slot_set_x (SCM obj, SCM slot_name, SCM value); 247 248 SCM_API SCM scm_compute_applicable_methods (SCM gf, SCM args, long len, int scm_find_method); 249 SCM_API SCM scm_sys_compute_applicable_methods (SCM gf, SCM args); 250 #ifdef GUILE_DEBUG 251 SCM_API SCM scm_pure_generic_p (SCM obj); 252 #endif 253 254 SCM_API SCM scm_sys_compute_slots (SCM c); 255 SCM_API SCM scm_i_get_keyword (SCM key, SCM l, long len, SCM default_value, const char *subr); 256 SCM_API SCM scm_get_keyword (SCM key, SCM l, SCM default_value); 257 SCM_API SCM scm_sys_initialize_object (SCM obj, SCM initargs); 258 SCM_API SCM scm_sys_prep_layout_x (SCM c); 259 SCM_API SCM scm_sys_inherit_magic_x (SCM c, SCM dsupers); 260 SCM_API SCM scm_instance_p (SCM obj); 261 SCM_API SCM scm_class_name (SCM obj); 262 SCM_API SCM scm_class_direct_supers (SCM obj); 263 SCM_API SCM scm_class_direct_slots (SCM obj); 264 SCM_API SCM scm_class_direct_subclasses (SCM obj); 265 SCM_API SCM scm_class_direct_methods (SCM obj); 266 SCM_API SCM scm_class_precedence_list (SCM obj); 267 SCM_API SCM scm_class_slots (SCM obj); 268 SCM_API SCM scm_class_environment (SCM obj); 269 SCM_API SCM scm_generic_function_name (SCM obj); 270 SCM_API SCM scm_generic_function_methods (SCM obj); 271 SCM_API SCM scm_method_generic_function (SCM obj); 272 SCM_API SCM scm_method_specializers (SCM obj); 273 SCM_API SCM scm_method_procedure (SCM obj); 274 SCM_API SCM scm_accessor_method_slot_definition (SCM obj); 275 SCM_API SCM scm_sys_tag_body (SCM body); 276 SCM_API SCM scm_sys_fast_slot_ref (SCM obj, SCM index); 277 SCM_API SCM scm_sys_fast_slot_set_x (SCM obj, SCM index, SCM value); 278 SCM_API SCM scm_slot_ref_using_class (SCM cls, SCM obj, SCM slot_name); 279 SCM_API SCM scm_slot_set_using_class_x (SCM cls, SCM obj, SCM slot_name, SCM value); 280 SCM_API SCM scm_slot_bound_using_class_p (SCM cls, SCM obj, SCM slot_name); 281 SCM_API SCM scm_slot_exists_using_class_p (SCM cls, SCM obj, SCM slot_name); 282 SCM_API SCM scm_slot_bound_p (SCM obj, SCM slot_name); 283 SCM_API SCM scm_slot_exists_p (SCM obj, SCM slot_name); 284 SCM_API SCM scm_sys_modify_instance (SCM old, SCM newinst); 285 SCM_API SCM scm_sys_modify_class (SCM old, SCM newcls); 286 SCM_API SCM scm_sys_invalidate_class (SCM cls); 287 SCM_API SCM scm_make_method_cache (SCM gf); 288 SCM_API SCM scm_sys_invalidate_method_cache_x (SCM gf); 289 SCM_API SCM scm_generic_capability_p (SCM proc); 290 SCM_API SCM scm_enable_primitive_generic_x (SCM subrs); 291 SCM_API SCM scm_primitive_generic_generic (SCM subr); 292 SCM_API void scm_c_extend_primitive_generic (SCM subr, SCM extension); 293 SCM_API SCM stklos_version (void); 294 SCM_API SCM scm_make (SCM args); 295 SCM_API SCM scm_find_method (SCM args); 296 SCM_API SCM scm_sys_method_more_specific_p (SCM m1, SCM m2, SCM targs); 297 298 SCM_API SCM scm_init_goops_builtins (void); 299 SCM_API void scm_init_goops (void); 300 301 #if (SCM_ENABLE_DEPRECATED == 1) 302 303 #define SCM_INST_TYPE(x) SCM_OBJ_CLASS_FLAGS (x) 304 #define SCM_SIMPLEMETHODP(x) \ 305 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_SIMPLE_METHOD)) 306 #define SCM_FASTMETHODP(x) \ 307 (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) \ 308 & (SCM_CLASSF_ACCESSOR_METHOD \ 309 | SCM_CLASSF_SIMPLE_METHOD))) 310 311 312 #endif 313 314 #endif /* SCM_GOOPS_H */ 315 316 /* 317 Local Variables: 318 c-file-style: "gnu" 319 End: 320 */ 321