libguile/goops.h

   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, 2008, 2009 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 License
  10  * as published by the Free Software Foundation; either version 3 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * 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
  21  * 02110-1301 USA
  22  */
  23
  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
  35 #include "libguile/validate.h"
  36
  37 /* {Class flags}
  38  *
  39  * These are used for efficient identification of instances of a
  40  * certain class or its subclasses when traversal of the inheritance
  41  * graph would be too costly.
  42  */
  43 #define SCM_VTABLE_FLAG_GOOPS_CLASS SCM_VTABLE_FLAG_GOOPS_0
  44 #define SCM_VTABLE_FLAG_GOOPS_VALID SCM_VTABLE_FLAG_GOOPS_1
  45 #define SCM_VTABLE_FLAG_GOOPS_METACLASS SCM_VTABLE_FLAG_GOOPS_2
  46 #define SCM_VTABLE_FLAG_GOOPS_FOREIGN SCM_VTABLE_FLAG_GOOPS_3
  47 #define SCM_VTABLE_FLAG_GOOPS_PURE_GENERIC SCM_VTABLE_FLAG_GOOPS_4
  48 #define SCM_VTABLE_FLAG_GOOPS_SIMPLE_METHOD SCM_VTABLE_FLAG_GOOPS_5
  49 #define SCM_VTABLE_FLAG_GOOPS_ACCESSOR_METHOD SCM_VTABLE_FLAG_GOOPS_6
  50
  51 #define SCM_CLASS_OF(x)         SCM_STRUCT_VTABLE (x)
  52 #define SCM_CLASS_FLAGS(class) (SCM_VTABLE_FLAGS (class))
  53 #define SCM_OBJ_CLASS_FLAGS(obj) (SCM_STRUCT_VTABLE_FLAGS (obj))
  54 #define SCM_SET_CLASS_FLAGS(c, f) (SCM_SET_VTABLE_FLAGS (c, f))
  55 #define SCM_CLEAR_CLASS_FLAGS(c, f) (SCM_CLEAR_VTABLE_FLAGS (c, f))
  56
  57 #define SCM_CLASSF_FOREIGN       SCM_VTABLE_FLAG_GOOPS_FOREIGN
  58 #define SCM_CLASSF_METACLASS     SCM_VTABLE_FLAG_GOOPS_METACLASS
  59 #define SCM_CLASSF_PURE_GENERIC  SCM_VTABLE_FLAG_GOOPS_PURE_GENERIC
  60 #define SCM_CLASSF_GOOPS_VALID   SCM_VTABLE_FLAG_GOOPS_VALID
  61 #define SCM_CLASSF_GOOPS         SCM_VTABLE_FLAG_GOOPS_CLASS
  62 #define SCM_CLASSF_SIMPLE_METHOD SCM_VTABLE_FLAG_GOOPS_SIMPLE_METHOD
  63 #define SCM_CLASSF_ACCESSOR_METHOD SCM_VTABLE_FLAG_GOOPS_ACCESSOR_METHOD
  64 #define SCM_CLASSF_GOOPS_OR_VALID (SCM_CLASSF_GOOPS | SCM_CLASSF_GOOPS_VALID)
  65
  66 /*
  67  * scm_class_class
  68  */
  69
  70 /* see also, SCM_VTABLE_BASE_LAYOUT, and build_class_class_slots */
  71 #define SCM_CLASS_CLASS_LAYOUT \
  72   "pw" /* redefined */ \
  73   "ur" /* h0 */ \
  74   "ur" /* h1 */ \
  75   "ur" /* h2 */ \
  76   "ur" /* h3 */ \
  77   "ur" /* h4 */ \
  78   "ur" /* h5 */ \
  79   "ur" /* h6 */ \
  80   "ur" /* h7 */ \
  81   "pw" /* direct supers */ \
  82   "pw" /* direct slots */ \
  83   "pw" /* direct subclasses */ \
  84   "pw" /* direct methods */ \
  85   "pw" /* cpl */ \
  86   "pw" /* default-slot-definition-class */ \
  87   "pw" /* slots */ \
  88   "pw" /* getters-n-setters */ \
  89   "pw" /* keyword access */ \
  90   "pw" /* nfields */ \
  91   "pw" /* environment */
  92
  93 #define scm_si_redefined         (scm_vtable_offset_user + 0)
  94 #define scm_si_h0                (scm_vtable_offset_user + 1)
  95 #define scm_si_hashsets          scm_si_h0
  96 #define scm_si_h1                (scm_vtable_offset_user + 2)
  97 #define scm_si_h2                (scm_vtable_offset_user + 3)
  98 #define scm_si_h3                (scm_vtable_offset_user + 4)
  99 #define scm_si_h4                (scm_vtable_offset_user + 5)
 100 #define scm_si_h5                (scm_vtable_offset_user + 6)
 101 #define scm_si_h6                (scm_vtable_offset_user + 7)
 102 #define scm_si_h7                (scm_vtable_offset_user + 8)
 103 #define scm_si_direct_supers     (scm_vtable_offset_user + 9) /* (class ...) */
 104 #define scm_si_direct_slots      (scm_vtable_offset_user + 10) /* ((name . options) ...) */
 105 #define scm_si_direct_subclasses (scm_vtable_offset_user + 11) /* (class ...) */
 106 #define scm_si_direct_methods    (scm_vtable_offset_user + 12) /* (methods ...) */
 107 #define scm_si_cpl               (scm_vtable_offset_user + 13) /* (class ...) */
 108 #define scm_si_slotdef_class     (scm_vtable_offset_user + 14)
 109 #define scm_si_slots             (scm_vtable_offset_user + 15) /* ((name . options) ...) */
 110 #define scm_si_name_access       (scm_vtable_offset_user + 16)
 111 #define scm_si_getters_n_setters scm_si_name_access
 112 #define scm_si_keyword_access    (scm_vtable_offset_user + 17)
 113 #define scm_si_nfields           (scm_vtable_offset_user + 18) /* an integer */
 114 #define scm_si_environment       (scm_vtable_offset_user + 19) /* The environment in which class is built  */
 115 #define SCM_N_CLASS_SLOTS        (scm_vtable_offset_user + 20)
 116
 117 typedef struct scm_t_method {
 118   SCM generic_function;
 119   SCM specializers;
 120   SCM procedure;
 121 } scm_t_method;
 122
 123 #define SCM_METHOD(obj) ((scm_t_method *) SCM_STRUCT_DATA (obj))
 124
 125 #define SCM_OBJ_CLASS_REDEF(x)  (SCM_PACK (SCM_STRUCT_VTABLE_DATA (x) [scm_si_redefined]))
 126 #define SCM_INST(x)            SCM_STRUCT_DATA (x)
 127
 128 #define SCM_CLASS_OF(x)        SCM_STRUCT_VTABLE (x)
 129 #define SCM_ACCESSORS_OF(x)    (SCM_PACK (SCM_STRUCT_VTABLE_DATA (x)[scm_si_getters_n_setters]))
 130
 131 #define SCM_CLASSP(x) \
 132   (SCM_STRUCTP (x) && SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_METACLASS)
 133 #define SCM_VALIDATE_CLASS(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, CLASSP, "class")
 134
 135 #define SCM_INSTANCEP(x) \
 136   (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_GOOPS))
 137 #define SCM_VALIDATE_INSTANCE(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, INSTANCEP, "instance")
 138
 139 #define SCM_PUREGENERICP(x) \
 140   (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_PURE_GENERIC))
 141 #define SCM_VALIDATE_PUREGENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, PUREGENERICP, "pure generic function")
 142
 143 #define SCM_ACCESSORP(x) \
 144   (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_ACCESSOR_METHOD))
 145 #define SCM_VALIDATE_ACCESSOR(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, ACCESSORP, "accessor")
 146
 147 #define SCM_SLOT(x, i)         (SCM_STRUCT_SLOT_REF (x, i))
 148 #define SCM_SET_SLOT(x, i, v)  (SCM_STRUCT_SLOT_SET (x, i, v))
 149 #define SCM_INSTANCE_HASH(c, i) (SCM_INST (c) [scm_si_hashsets + (i)])
 150 #define SCM_SET_HASHSET(c, i, h)  (SCM_INST (c) [scm_si_hashsets + (i)] = (h))
 151
 152 #define SCM_SUBCLASSP(c1, c2)  (scm_is_true (scm_c_memq (c2, SCM_SLOT (c1, scm_si_cpl))))
 153 #define SCM_IS_A_P(x, c) \
 154   (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), c))
 155
 156 #define SCM_GENERICP(x) \
 157   (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_generic))
 158 #define SCM_VALIDATE_GENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, GENERICP, "generic function")
 159
 160 #define SCM_METHODP(x) \
 161   (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_method))
 162 #define SCM_VALIDATE_METHOD(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, METHODP, "method")
 163
 164 #define SCM_SET_CLASS_DESTRUCTOR(c, d) SCM_SET_VTABLE_DESTRUCTOR (c, d)
 165
 166 #define SCM_GENERIC_METHOD_CACHE(G) (SCM_PACK (SCM_STRUCT_DATA (G) [scm_si_generic_cache]))
 167 #define SCM_SET_GENERIC_METHOD_CACHE(G,C) (SCM_STRUCT_DATA (G) [scm_si_generic_cache] = SCM_UNPACK (C))
 168 #define SCM_GENERIC_SETTER(G) (SCM_PACK (SCM_STRUCT_DATA (G) [scm_si_generic_setter_cache]))
 169 #define SCM_SET_GENERIC_SETTER(G,C) (SCM_STRUCT_DATA (G) [scm_si_generic_setter_cache] = SCM_UNPACK (C))
 170 #define SCM_MCACHE_N_SPECIALIZED(C) SCM_CADDR (C)
 171 #define SCM_SET_MCACHE_N_SPECIALIZED(C, X) SCM_SETCAR (SCM_CDDR (C), X)
 172
 173 #define SCM_INITIAL_MCACHE_SIZE   1
 174
 175 #define scm_si_methods           0  /* offset of methods slot in a <generic> */
 176 #define scm_si_n_specialized     1
 177 #define scm_si_used_by           2
 178 #define scm_si_cache_mutex       3
 179 #define scm_si_extended_by       4
 180 #define scm_si_generic_cache     5
 181 #define scm_si_generic_setter_cache 6
 182
 183 #define scm_si_generic_function  0  /* offset of gf    slot in a <method> */
 184 #define scm_si_specializers      1  /* offset of spec. slot in a <method> */
 185 #define scm_si_procedure         2  /* offset of proc. slot in a <method> */
 186 #define scm_si_code_table        3  /* offset of code. slot in a <method> */
 187 #define scm_si_formals           4  /* offset of form. slot in a <method> */
 188 #define scm_si_body              5  /* offset of body  slot in a <method> */
 189 #define scm_si_make_procedure    6  /* offset of makep.slot in a <method> */
 190
 191 /* C interface */
 192 SCM_API SCM scm_class_boolean;
 193 SCM_API SCM scm_class_char;
 194 SCM_API SCM scm_class_pair;
 195 SCM_API SCM scm_class_procedure;
 196 SCM_API SCM scm_class_string;
 197 SCM_API SCM scm_class_symbol;
 198 SCM_API SCM scm_class_procedure_with_setter;
 199 SCM_API SCM scm_class_primitive_generic;
 200 SCM_API SCM scm_class_vector, scm_class_null;
 201 SCM_API SCM scm_class_real;
 202 SCM_API SCM scm_class_complex;
 203 SCM_API SCM scm_class_integer;
 204 SCM_API SCM scm_class_fraction;
 205 SCM_API SCM scm_class_unknown;
 206 SCM_API SCM scm_port_class[];
 207 SCM_API SCM scm_smob_class[];
 208 SCM_API SCM scm_class_top;
 209 SCM_API SCM scm_class_object;
 210 SCM_API SCM scm_class_class;
 211 SCM_API SCM scm_class_applicable;
 212 SCM_API SCM scm_class_entity;
 213 SCM_API SCM scm_class_entity_with_setter;
 214 SCM_API SCM scm_class_generic;
 215 SCM_API SCM scm_class_generic_with_setter;
 216 SCM_API SCM scm_class_accessor;
 217 SCM_API SCM scm_class_extended_generic;
 218 SCM_API SCM scm_class_extended_generic_with_setter;
 219 SCM_API SCM scm_class_extended_accessor;
 220 SCM_API SCM scm_class_method;
 221 SCM_API SCM scm_class_simple_method;
 222 SCM_API SCM scm_class_accessor_method;
 223 SCM_API SCM scm_class_procedure_class;
 224 SCM_API SCM scm_class_entity_class;
 225 SCM_API SCM scm_class_number;
 226 SCM_API SCM scm_class_list;
 227 SCM_API SCM scm_class_keyword;
 228 SCM_API SCM scm_class_port;
 229 SCM_API SCM scm_class_input_output_port;
 230 SCM_API SCM scm_class_input_port;
 231 SCM_API SCM scm_class_output_port;
 232 SCM_API SCM scm_class_foreign_class;
 233 SCM_API SCM scm_class_foreign_object;
 234 SCM_API SCM scm_class_foreign_slot;
 235 SCM_API SCM scm_class_self;
 236 SCM_API SCM scm_class_protected;
 237 SCM_API SCM scm_class_hidden;
 238 SCM_API SCM scm_class_opaque;
 239 SCM_API SCM scm_class_read_only;
 240 SCM_API SCM scm_class_protected_hidden;
 241 SCM_API SCM scm_class_protected_opaque;
 242 SCM_API SCM scm_class_protected_read_only;
 243 SCM_API SCM scm_class_scm;
 244 SCM_API SCM scm_class_int;
 245 SCM_API SCM scm_class_float;
 246 SCM_API SCM scm_class_double;
 247 SCM_API const char *scm_s_slot_set_x;
 248
 249 SCM_API SCM scm_no_applicable_method;
 250
 251 SCM_API SCM scm_module_goops;
 252
 253 SCM_API SCM scm_goops_version (void);
 254 SCM_API SCM scm_oldfmt (SCM);
 255 SCM_API char *scm_c_oldfmt0 (char *);
 256 SCM_API char *scm_c_oldfmt (char *, int n);
 257 SCM_API void scm_load_goops (void);
 258 SCM_API SCM scm_make_extended_class (char const *type_name, int applicablep);
 259 SCM_API void scm_make_port_classes (long ptobnum, char *type_name);
 260 SCM_API SCM scm_ensure_accessor (SCM name);
 261 SCM_API void scm_add_method (SCM gf, SCM m);
 262 SCM_API SCM scm_class_of (SCM obj);
 263
 264 /* Low level functions exported */
 265 SCM_API SCM scm_make_next_method (SCM methods, SCM args, SCM gf);
 266 SCM_API SCM scm_basic_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
 267 SCM_API SCM scm_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
 268
 269 /* Primitives exported */
 270 SCM_API SCM scm_sys_allocate_instance (SCM c, SCM initargs);
 271 SCM_API SCM scm_sys_set_object_setter_x (SCM obj, SCM setter);
 272 SCM_API SCM scm_slot_ref (SCM obj, SCM slot_name);
 273 SCM_API SCM scm_slot_set_x (SCM obj, SCM slot_name, SCM value);
 274
 275 SCM_API SCM scm_compute_applicable_methods (SCM gf, SCM args, long len, int scm_find_method);
 276 SCM_API SCM scm_sys_compute_applicable_methods (SCM gf, SCM args);
 277 #ifdef GUILE_DEBUG
 278 SCM_API SCM scm_pure_generic_p (SCM obj);
 279 #endif
 280
 281 SCM_API SCM scm_sys_compute_slots (SCM c);
 282 SCM_INTERNAL void scm_i_inherit_applicable (SCM c);
 283 SCM_INTERNAL SCM scm_i_get_keyword (SCM key, SCM l, long len,
 284                                     SCM default_value, const char *subr);
 285 SCM_API SCM scm_get_keyword (SCM key, SCM l, SCM default_value);
 286 SCM_API SCM scm_sys_initialize_object (SCM obj, SCM initargs);
 287 SCM_API SCM scm_sys_prep_layout_x (SCM c);
 288 SCM_API SCM scm_sys_inherit_magic_x (SCM c, SCM dsupers);
 289 SCM_API SCM scm_instance_p (SCM obj);
 290 SCM_API SCM scm_class_name (SCM obj);
 291 SCM_API SCM scm_class_direct_supers (SCM obj);
 292 SCM_API SCM scm_class_direct_slots (SCM obj);
 293 SCM_API SCM scm_class_direct_subclasses (SCM obj);
 294 SCM_API SCM scm_class_direct_methods (SCM obj);
 295 SCM_API SCM scm_class_precedence_list (SCM obj);
 296 SCM_API SCM scm_class_slots (SCM obj);
 297 SCM_API SCM scm_class_environment (SCM obj);
 298 SCM_API SCM scm_generic_function_name (SCM obj);
 299 SCM_API SCM scm_generic_function_methods (SCM obj);
 300 SCM_API SCM scm_method_generic_function (SCM obj);
 301 SCM_API SCM scm_method_specializers (SCM obj);
 302 SCM_API SCM scm_method_procedure (SCM obj);
 303 SCM_API SCM scm_accessor_method_slot_definition (SCM obj);
 304 SCM_API SCM scm_sys_tag_body (SCM body);
 305 SCM_API SCM scm_sys_fast_slot_ref (SCM obj, SCM index);
 306 SCM_API SCM scm_sys_fast_slot_set_x (SCM obj, SCM index, SCM value);
 307 SCM_API SCM scm_slot_ref_using_class (SCM cls, SCM obj, SCM slot_name);
 308 SCM_API SCM scm_slot_set_using_class_x (SCM cls, SCM obj, SCM slot_name, SCM value);
 309 SCM_API SCM scm_slot_bound_using_class_p (SCM cls, SCM obj, SCM slot_name);
 310 SCM_API SCM scm_slot_exists_using_class_p (SCM cls, SCM obj, SCM slot_name);
 311 SCM_API SCM scm_slot_bound_p (SCM obj, SCM slot_name);
 312 SCM_API SCM scm_slot_exists_p (SCM obj, SCM slot_name);
 313 SCM_API SCM scm_sys_modify_instance (SCM old, SCM newinst);
 314 SCM_API SCM scm_sys_modify_class (SCM old, SCM newcls);
 315 SCM_API SCM scm_sys_invalidate_class (SCM cls);
 316 SCM_API SCM scm_make_method_cache (SCM gf);
 317 SCM_API SCM scm_sys_invalidate_method_cache_x (SCM gf);
 318 SCM_API SCM scm_generic_capability_p (SCM proc);
 319 SCM_API SCM scm_enable_primitive_generic_x (SCM subrs);
 320 SCM_API SCM scm_primitive_generic_generic (SCM subr);
 321 SCM_API void scm_c_extend_primitive_generic (SCM subr, SCM extension);
 322 SCM_API SCM stklos_version (void);
 323 SCM_API SCM scm_make (SCM args);
 324 SCM_API SCM scm_find_method (SCM args);
 325 SCM_API SCM scm_sys_method_more_specific_p (SCM m1, SCM m2, SCM targs);
 326 SCM_API void scm_change_object_class (SCM, SCM, SCM);
 327 SCM_API SCM scm_memoize_method (SCM x, SCM args);
 328 SCM_API SCM scm_mcache_lookup_cmethod (SCM cache, SCM args);
 329 SCM_API SCM scm_mcache_compute_cmethod (SCM cache, SCM args);
 330 /* The following are declared in __scm.h
 331 SCM_API SCM scm_call_generic_0 (SCM gf);
 332 SCM_API SCM scm_call_generic_1 (SCM gf, SCM a1);
 333 SCM_API SCM scm_call_generic_2 (SCM gf, SCM a1, SCM a2);
 334 SCM_API SCM scm_apply_generic (SCM gf, SCM args);
 335 */
 336 SCM_API SCM scm_call_generic_3 (SCM gf, SCM a1, SCM a2, SCM a3);
 337
 338
 339 SCM_INTERNAL SCM scm_init_goops_builtins (void);
 340 SCM_INTERNAL void scm_init_goops (void);
 341
 342 #endif  /* SCM_GOOPS_H */
 343
 344 /*
 345   Local Variables:
 346   c-file-style: "gnu"
 347   End:
 348 */