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, 2011, 2015 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_PURE_GENERIC SCM_VTABLE_FLAG_GOOPS_2
  46
  47 #define SCM_CLASS_OF(x)         SCM_STRUCT_VTABLE (x)
  48 #define SCM_CLASS_FLAGS(class) (SCM_VTABLE_FLAGS (class))
  49 #define SCM_OBJ_CLASS_FLAGS(obj) (SCM_STRUCT_VTABLE_FLAGS (obj))
  50 #define SCM_SET_CLASS_FLAGS(c, f) (SCM_SET_VTABLE_FLAGS (c, f))
  51 #define SCM_CLEAR_CLASS_FLAGS(c, f) (SCM_CLEAR_VTABLE_FLAGS (c, f))
  52
  53 #define SCM_CLASSF_METACLASS     (SCM_VTABLE_FLAG_GOOPS_CLASS|SCM_VTABLE_FLAG_VTABLE)
  54 #define SCM_CLASSF_PURE_GENERIC  SCM_VTABLE_FLAG_GOOPS_PURE_GENERIC
  55 #define SCM_CLASSF_GOOPS_VALID   SCM_VTABLE_FLAG_GOOPS_VALID
  56 #define SCM_CLASSF_GOOPS         SCM_VTABLE_FLAG_GOOPS_CLASS
  57 #define SCM_CLASSF_GOOPS_OR_VALID (SCM_CLASSF_GOOPS | SCM_CLASSF_GOOPS_VALID)
  58
  59 /*
  60  * scm_class_class
  61  */
  62
  63 /* see also, SCM_VTABLE_BASE_LAYOUT, and build_class_class_slots */
  64 #define SCM_CLASS_CLASS_LAYOUT                  \
  65   "pw" /* redefined */                          \
  66   "uw" /* h0 */                                 \
  67   "uw" /* h1 */                                 \
  68   "uw" /* h2 */                                 \
  69   "uw" /* h3 */                                 \
  70   "uw" /* h4 */                                 \
  71   "uw" /* h5 */                                 \
  72   "uw" /* h6 */                                 \
  73   "uw" /* h7 */                                 \
  74   "pw" /* direct supers */                      \
  75   "pw" /* direct slots */                       \
  76   "pw" /* direct subclasses */                  \
  77   "pw" /* direct methods */                     \
  78   "pw" /* cpl */                                \
  79   "pw" /* slots */                              \
  80   "pw" /* getters-n-setters */                  \
  81   "pw" /* nfields */
  82
  83 #define scm_si_redefined         (scm_vtable_offset_user + 0)
  84 #define scm_si_h0                (scm_vtable_offset_user + 1)
  85 #define scm_si_hashsets          scm_si_h0
  86 #define scm_si_h1                (scm_vtable_offset_user + 2)
  87 #define scm_si_h2                (scm_vtable_offset_user + 3)
  88 #define scm_si_h3                (scm_vtable_offset_user + 4)
  89 #define scm_si_h4                (scm_vtable_offset_user + 5)
  90 #define scm_si_h5                (scm_vtable_offset_user + 6)
  91 #define scm_si_h6                (scm_vtable_offset_user + 7)
  92 #define scm_si_h7                (scm_vtable_offset_user + 8)
  93 #define scm_si_direct_supers     (scm_vtable_offset_user + 9) /* (class ...) */
  94 #define scm_si_direct_slots      (scm_vtable_offset_user + 10) /* ((name . options) ...) */
  95 #define scm_si_direct_subclasses (scm_vtable_offset_user + 11) /* (class ...) */
  96 #define scm_si_direct_methods    (scm_vtable_offset_user + 12) /* (methods ...) */
  97 #define scm_si_cpl               (scm_vtable_offset_user + 13) /* (class ...) */
  98 #define scm_si_slots             (scm_vtable_offset_user + 14) /* ((name . options) ...) */
  99 #define scm_si_getters_n_setters (scm_vtable_offset_user + 15)
 100 #define scm_si_nfields           (scm_vtable_offset_user + 16) /* an integer */
 101 #define SCM_N_CLASS_SLOTS        (scm_vtable_offset_user + 17)
 102
 103 #define SCM_OBJ_CLASS_REDEF(x)  (SCM_PACK (SCM_STRUCT_VTABLE_DATA (x) [scm_si_redefined]))
 104 #define SCM_INST(x)            SCM_STRUCT_DATA (x)
 105
 106 #define SCM_CLASS_OF(x)        SCM_STRUCT_VTABLE (x)
 107 #define SCM_ACCESSORS_OF(x)    (SCM_PACK (SCM_STRUCT_VTABLE_DATA (x)[scm_si_getters_n_setters]))
 108
 109 #define SCM_CLASSP(x) \
 110   (SCM_STRUCTP (x) && SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_METACLASS)
 111 #define SCM_VALIDATE_CLASS(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, CLASSP, "class")
 112
 113 #define SCM_INSTANCEP(x) \
 114   (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_GOOPS))
 115 #define SCM_VALIDATE_INSTANCE(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, INSTANCEP, "instance")
 116
 117 #define SCM_PUREGENERICP(x) \
 118   (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_PURE_GENERIC))
 119 #define SCM_VALIDATE_PUREGENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, PUREGENERICP, "pure generic function")
 120
 121 #define SCM_SLOT(x, i)         (SCM_STRUCT_SLOT_REF (x, i))
 122 #define SCM_SET_SLOT(x, i, v)  (SCM_STRUCT_SLOT_SET (x, i, v))
 123 #define SCM_INSTANCE_HASH(c, i) (SCM_INST (c) [scm_si_hashsets + (i)])
 124 #define SCM_SET_HASHSET(c, i, h)  (SCM_INST (c) [scm_si_hashsets + (i)] = (h))
 125
 126 #define SCM_SUBCLASSP(c1, c2)  (scm_is_true (scm_c_memq (c2, SCM_SLOT (c1, scm_si_cpl))))
 127 #define SCM_IS_A_P(x, c) \
 128   (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), c))
 129
 130 #define SCM_GENERICP(x) \
 131   (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_generic))
 132 #define SCM_VALIDATE_GENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, GENERICP, "generic function")
 133
 134 #define SCM_METHODP(x) \
 135   (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_method))
 136 #define SCM_VALIDATE_METHOD(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, METHODP, "method")
 137
 138 #define SCM_SET_CLASS_DESTRUCTOR(c, d) SCM_SET_VTABLE_DESTRUCTOR (c, d)
 139
 140 #define SCM_SET_GENERIC_DISPATCH_PROCEDURE(G,C) (SCM_STRUCT_SLOT_SET (G, scm_si_dispatch_procedure, (C)))
 141 #define SCM_CLEAR_GENERIC_EFFECTIVE_METHODS(G) (SCM_STRUCT_SLOT_SET (G, scm_si_effective_methods, SCM_EOL));
 142
 143 #define SCM_GENERIC_SETTER(G) (SCM_PACK (SCM_STRUCT_DATA (G) [scm_si_generic_setter]))
 144 #define SCM_SET_GENERIC_SETTER(G,C) (SCM_STRUCT_DATA (G) [scm_si_generic_setter] = SCM_UNPACK (C))
 145
 146 #define scm_si_dispatch_procedure scm_applicable_struct_index_procedure /* 0 */
 147 #define scm_si_methods            1
 148 #define scm_si_n_specialized      2
 149 #define scm_si_extended_by        3
 150 #define scm_si_effective_methods  4
 151 #define scm_si_generic_setter     5
 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 #define scm_si_procedure         2  /* offset of proc. slot in a <method> */
 156 #define scm_si_formals           3  /* offset of form. slot in a <method> */
 157 #define scm_si_body              4  /* offset of body  slot in a <method> */
 158 #define scm_si_make_procedure    5  /* offset of makep.slot in a <method> */
 159
 160 /* C interface */
 161 SCM_API SCM scm_class_boolean;
 162 SCM_API SCM scm_class_char;
 163 SCM_API SCM scm_class_pair;
 164 SCM_API SCM scm_class_procedure;
 165 SCM_API SCM scm_class_string;
 166 SCM_API SCM scm_class_symbol;
 167 SCM_API SCM scm_class_primitive_generic;
 168 SCM_API SCM scm_class_vector;
 169 SCM_API SCM scm_class_null;
 170 SCM_API SCM scm_class_real;
 171 SCM_API SCM scm_class_complex;
 172 SCM_API SCM scm_class_integer;
 173 SCM_API SCM scm_class_fraction;
 174 SCM_API SCM scm_class_unknown;
 175 SCM_API SCM scm_port_class[];
 176 SCM_API SCM scm_smob_class[];
 177 SCM_API SCM scm_class_top;
 178 SCM_API SCM scm_class_object;
 179 SCM_API SCM scm_class_class;
 180 SCM_API SCM scm_class_applicable;
 181 SCM_API SCM scm_class_applicable_struct;
 182 SCM_API SCM scm_class_applicable_struct_with_setter;
 183 SCM_API SCM scm_class_generic;
 184 SCM_API SCM scm_class_generic_with_setter;
 185 SCM_API SCM scm_class_accessor;
 186 SCM_API SCM scm_class_extended_generic;
 187 SCM_API SCM scm_class_extended_generic_with_setter;
 188 SCM_API SCM scm_class_extended_accessor;
 189 SCM_API SCM scm_class_method;
 190 SCM_API SCM scm_class_accessor_method;
 191 SCM_API SCM scm_class_procedure_class;
 192 SCM_API SCM scm_class_applicable_struct_class;
 193 SCM_API SCM scm_class_number;
 194 SCM_API SCM scm_class_list;
 195 SCM_API SCM scm_class_keyword;
 196 SCM_API SCM scm_class_port;
 197 SCM_API SCM scm_class_input_output_port;
 198 SCM_API SCM scm_class_input_port;
 199 SCM_API SCM scm_class_output_port;
 200 SCM_API SCM scm_class_foreign_slot;
 201 SCM_API SCM scm_class_self;
 202 SCM_API SCM scm_class_protected;
 203 SCM_API SCM scm_class_hidden;
 204 SCM_API SCM scm_class_opaque;
 205 SCM_API SCM scm_class_read_only;
 206 SCM_API SCM scm_class_protected_hidden;
 207 SCM_API SCM scm_class_protected_opaque;
 208 SCM_API SCM scm_class_protected_read_only;
 209 SCM_API SCM scm_class_scm;
 210 SCM_API SCM scm_class_int;
 211 SCM_API SCM scm_class_float;
 212 SCM_API SCM scm_class_double;
 213
 214 SCM_API SCM scm_module_goops;
 215
 216 SCM_API SCM scm_goops_version (void);
 217 SCM_API void scm_load_goops (void);
 218 SCM_API SCM scm_make_extended_class (char const *type_name, int applicablep);
 219 SCM_API void scm_make_port_classes (long ptobnum, char *type_name);
 220 SCM_API SCM scm_ensure_accessor (SCM name);
 221 SCM_API SCM scm_class_of (SCM obj);
 222
 223 /* Low level functions exported */
 224 SCM_API SCM scm_make_next_method (SCM methods, SCM args, SCM gf);
 225 SCM_INTERNAL SCM scm_make_standard_class (SCM meta, SCM name, SCM dsupers,
 226                                           SCM dslots);
 227
 228 /* Primitives exported */
 229 SCM_API SCM scm_sys_allocate_instance (SCM c, SCM initargs);
 230 SCM_API SCM scm_sys_set_object_setter_x (SCM obj, SCM setter);
 231 SCM_API SCM scm_slot_ref (SCM obj, SCM slot_name);
 232 SCM_API SCM scm_slot_set_x (SCM obj, SCM slot_name, SCM value);
 233
 234 #ifdef GUILE_DEBUG
 235 SCM_API SCM scm_pure_generic_p (SCM obj);
 236 #endif
 237
 238 SCM_INTERNAL void scm_i_inherit_applicable (SCM c);
 239 SCM_INTERNAL SCM scm_i_get_keyword (SCM key, SCM l, long len,
 240                                     SCM default_value, const char *subr);
 241 SCM_API SCM scm_get_keyword (SCM key, SCM l, SCM default_value);
 242 SCM_API SCM scm_sys_initialize_object (SCM obj, SCM initargs);
 243 SCM_API SCM scm_sys_inherit_magic_x (SCM c, SCM dsupers);
 244 SCM_API SCM scm_instance_p (SCM obj);
 245 SCM_API SCM scm_class_name (SCM obj);
 246 SCM_API SCM scm_class_direct_supers (SCM obj);
 247 SCM_API SCM scm_class_direct_slots (SCM obj);
 248 SCM_API SCM scm_class_direct_subclasses (SCM obj);
 249 SCM_API SCM scm_class_direct_methods (SCM obj);
 250 SCM_API SCM scm_class_precedence_list (SCM obj);
 251 SCM_API SCM scm_class_slots (SCM obj);
 252 SCM_API SCM scm_generic_function_name (SCM obj);
 253 SCM_API SCM scm_generic_function_methods (SCM obj);
 254 SCM_API SCM scm_method_generic_function (SCM obj);
 255 SCM_API SCM scm_method_specializers (SCM obj);
 256 SCM_API SCM scm_method_procedure (SCM obj);
 257 SCM_API SCM scm_slot_ref_using_class (SCM cls, SCM obj, SCM slot_name);
 258 SCM_API SCM scm_slot_set_using_class_x (SCM cls, SCM obj, SCM slot_name, SCM value);
 259 SCM_API SCM scm_slot_bound_using_class_p (SCM cls, SCM obj, SCM slot_name);
 260 SCM_API SCM scm_slot_exists_using_class_p (SCM cls, SCM obj, SCM slot_name);
 261 SCM_API SCM scm_slot_bound_p (SCM obj, SCM slot_name);
 262 SCM_API SCM scm_slot_exists_p (SCM obj, SCM slot_name);
 263 SCM_API SCM scm_sys_modify_instance (SCM old, SCM newinst);
 264 SCM_API SCM scm_sys_modify_class (SCM old, SCM newcls);
 265 SCM_API SCM scm_sys_invalidate_class (SCM cls);
 266 SCM_API SCM scm_sys_invalidate_method_cache_x (SCM gf);
 267 SCM_API SCM scm_generic_capability_p (SCM proc);
 268 SCM_API SCM scm_enable_primitive_generic_x (SCM subrs);
 269 SCM_INTERNAL SCM scm_set_primitive_generic_x (SCM subr, SCM generic);
 270 SCM_API SCM scm_primitive_generic_generic (SCM subr);
 271 SCM_API void scm_c_extend_primitive_generic (SCM subr, SCM extension);
 272 SCM_API SCM stklos_version (void);
 273 SCM_API SCM scm_make (SCM args);
 274 SCM_API void scm_change_object_class (SCM, SCM, SCM);
 275
 276 /* These procedures are for dispatching to a generic when a primitive
 277    fails to apply.  They raise a wrong-type-arg error if the primitive's
 278    generic has not been initialized yet.  */
 279 SCM_API SCM scm_wta_dispatch_0 (SCM gf, const char *subr);
 280 SCM_API SCM scm_wta_dispatch_1 (SCM gf, SCM a1, int pos, const char *subr);
 281 SCM_API SCM scm_wta_dispatch_2 (SCM gf, SCM a1, SCM a2, int pos, const char *subr);
 282 SCM_API SCM scm_wta_dispatch_n (SCM gf, SCM args, int pos, const char *subr);
 283
 284 SCM_INTERNAL SCM scm_i_define_class_for_vtable (SCM vtable);
 285
 286
 287 SCM_INTERNAL void scm_init_goops (void);
 288
 289 #endif  /* SCM_GOOPS_H */
 290
 291 /*
 292   Local Variables:
 293   c-file-style: "gnu"
 294   End:
 295 */