Replaced SCM_DEBUG_DEPRECATED with !SCM_ENABLE_DEPRECATED.
[bpt/guile.git] / libguile / goops.h
index 069fbfb..a288d84 100644 (file)
@@ -1,8 +1,8 @@
 /* classes: h_files */
 
-#ifndef GOOPSH
-#define GOOPSH
-/*     Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
+#ifndef SCM_GOOPS_H
+#define SCM_GOOPS_H
+/* Copyright (C) 1998,1999,2000,2001 Free Software Foundation, Inc.
  * 
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * scm_class_class
  */
 
-#define SCM_CLASS_CLASS_LAYOUT "pruosrpwpopopwururururururururpwpwpwpwpwpwpwpwpwpwpwpw"
+#define SCM_CLASS_CLASS_LAYOUT "prsrpwpopopwururururururururpwpwpwpwpwpwpwpwpwpwpwpw"
 
 #define scm_si_layout            0 /* the struct layout */
-#define scm_si_vcell             1 
-#define scm_si_vtable            2 
-#define scm_si_print             3 /* the struct print closure */
-#define scm_si_proc              4
-#define scm_si_setter            5 
+#define scm_si_vtable            1 
+#define scm_si_print             2 /* the struct print closure */
+#define scm_si_proc              3
+#define scm_si_setter            4 
 
-#define scm_si_goops_fields      6
+#define scm_si_goops_fields      5
 
-/* Defined in libguile/objects.c:
-#define scm_si_redefined         6    The class to which class was redefined.
-#define scm_si_hashsets                  7
+/* Defined in libguile/objects.h:
+#define scm_si_redefined         5    The class to which class was redefined.
+#define scm_si_hashsets                  6
 */
-#define scm_si_name             15 /* a symbol */
-#define scm_si_direct_supers    16 /* (class ...) */
-#define scm_si_direct_slots     17 /* ((name . options) ...) */
-#define scm_si_direct_subclasses 18 /* (class ...) */
-#define scm_si_direct_methods   19 /* (methods ...) */
-#define scm_si_cpl              20 /* (class ...) */
-#define scm_si_slotdef_class    21 
-#define scm_si_slots            22 /* ((name . options) ...) */
-#define scm_si_name_access      23 
-#define scm_si_keyword_access   24 
-#define scm_si_nfields          25 /* an integer */
-#define scm_si_environment      26 /* The environment in which class is built  */
-#define SCM_N_CLASS_SLOTS       27
-
-typedef struct scm_method_t {
+#define scm_si_name             14 /* a symbol */
+#define scm_si_direct_supers    15 /* (class ...) */
+#define scm_si_direct_slots     16 /* ((name . options) ...) */
+#define scm_si_direct_subclasses 17 /* (class ...) */
+#define scm_si_direct_methods   18 /* (methods ...) */
+#define scm_si_cpl              19 /* (class ...) */
+#define scm_si_slotdef_class    20 
+#define scm_si_slots            21 /* ((name . options) ...) */
+#define scm_si_name_access      22 
+#define scm_si_keyword_access   23 
+#define scm_si_nfields          24 /* an integer */
+#define scm_si_environment      25 /* The environment in which class is built  */
+#define SCM_N_CLASS_SLOTS       26
+
+typedef struct scm_t_method {
   SCM generic_function;
   SCM specializers;
   SCM procedure;
-} scm_method_t;
+} scm_t_method;
 
-#define SCM_METHOD(obj) ((scm_method_t *) SCM_STRUCT_DATA (obj))
+#define SCM_METHOD(obj) ((scm_t_method *) SCM_STRUCT_DATA (obj))
 
 #define SCM_CLASSF_SIMPLE_METHOD    (0x004 << 20)
 #define SCM_CLASSF_ACCESSOR_METHOD  (0x008 << 20)
@@ -117,41 +116,44 @@ typedef struct scm_method_t {
                                  & SCM_CLASSF_MASK)
 
 #define SCM_INST(x)           SCM_STRUCT_DATA (x)
-#define SCM_INST_TYPE(x)       SCM_OBJ_CLASS_FLAGS (x)
-/* Also defined in libguuile/objects.c */
+
+/* Also defined in libguile/objects.c */
 #define SCM_CLASS_OF(x)        SCM_STRUCT_VTABLE (x)
-#define SCM_ACCESSORS_OF(x)    (SCM_STRUCT_VTABLE_DATA (x)[scm_si_getters_n_setters])
-#define SCM_NUMBER_OF_SLOTS(x)\
+#define SCM_ACCESSORS_OF(x)    (SCM_PACK (SCM_STRUCT_VTABLE_DATA (x)[scm_si_getters_n_setters]))
+#define SCM_NUMBER_OF_SLOTS(x) \
  (SCM_UNPACK (SCM_STRUCT_DATA (x)[scm_struct_i_n_words]) \
-  - scm_struct_n_extra_words) \
+  - scm_struct_n_extra_words)
+
+#define SCM_CLASSP(x) \
+  (SCM_STRUCTP (x) && SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_METACLASS)
+#define SCM_VALIDATE_CLASS(pos, x) SCM_MAKE_VALIDATE (pos, x, CLASSP)
 
 #define SCM_INSTANCEP(x) \
-  (SCM_STRUCTP (x) && (SCM_INST_TYPE (x) & SCM_CLASSF_GOOPS))
+  (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_GOOPS))
 #define SCM_VALIDATE_INSTANCE(pos, x) SCM_MAKE_VALIDATE (pos, x, INSTANCEP)
 
 #define SCM_PUREGENERICP(x) \
-  (SCM_STRUCTP (x) && (SCM_INST_TYPE(x) & SCM_CLASSF_PURE_GENERIC))
-#define SCM_SIMPLEMETHODP(x)   (SCM_INST_TYPE(x) & SCM_CLASSF_SIMPLE_METHOD)
-#define SCM_ACCESSORP(x)       (SCM_INST_TYPE(x) & SCM_CLASSF_ACCESSOR_METHOD)
+  (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_PURE_GENERIC))
+#define SCM_VALIDATE_PUREGENERIC(pos, x) SCM_MAKE_VALIDATE (pos, x, PUREGENERICP)
+
+#define SCM_ACCESSORP(x) \
+  (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_ACCESSOR_METHOD))
 #define SCM_VALIDATE_ACCESSOR(pos, x) SCM_MAKE_VALIDATE (pos, x, ACCESSORP)
-#define SCM_FASTMETHODP(x)     (SCM_INST_TYPE(x) \
-                               & (SCM_CLASSF_ACCESSOR_METHOD \
-                                  | SCM_CLASSF_SIMPLE_METHOD))
 
-#define SCM_SLOT(x, i)         (SCM_INST(x)[i])
+#define SCM_SLOT(x, i)         (SCM_PACK (SCM_INST (x) [i]))
+#define SCM_SET_SLOT(x, i, v)  (SCM_INST (x) [i] = SCM_UNPACK (v))
+#define SCM_SET_HASHSET(c, i, h)  (SCM_INST (c) [scm_si_hashsets + (i)] = (h))
+
 #define SCM_SUBCLASSP(c1, c2)  (!SCM_FALSEP (scm_c_memq (c2, SCM_SLOT (c1, scm_si_cpl))))
-#define SCM_IS_A_P(x, c)       (SCM_NIMP (x) \
-                               && SCM_INSTANCEP (x) \
-                               && SCM_SUBCLASSP (SCM_CLASS_OF (x), c))
+#define SCM_IS_A_P(x, c) \
+  (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), c))
 
-#define SCM_CLASSP(x)   (SCM_STRUCTP (x) \
-                       && SCM_OBJ_CLASS_FLAGS (x) & SCM_CLASSF_METACLASS)
-#define SCM_VALIDATE_CLASS(pos, x) SCM_MAKE_VALIDATE (pos, x, CLASSP)
-#define SCM_GENERICP(x) (SCM_INSTANCEP (x) \
-                       && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_generic))
+#define SCM_GENERICP(x) \
+  (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_generic))
 #define SCM_VALIDATE_GENERIC(pos, x) SCM_MAKE_VALIDATE (pos, x, GENERICP)
-#define SCM_METHODP(x)  (SCM_INSTANCEP (x) \
-                       && SCM_SUBCLASSP(SCM_CLASS_OF(x), scm_class_method))
+
+#define SCM_METHODP(x) \
+  (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), scm_class_method))
 #define SCM_VALIDATE_METHOD(pos, x) SCM_MAKE_VALIDATE (pos, x, METHODP)
 
 #define SCM_MCACHE_N_SPECIALIZED(C) SCM_CADDR (C)
@@ -176,109 +178,139 @@ typedef struct scm_method_t {
 #define scm_si_code_table       3  /* offset of code. slot in a <method> */
 
 /* C interface */
-extern SCM scm_class_top, scm_class_object, scm_class_class;
-extern SCM scm_class_entity, scm_class_entity_with_setter;
-extern SCM scm_class_generic, scm_class_generic_with_setter, scm_class_method;
-extern SCM scm_class_simple_method, scm_class_accessor;
-extern SCM scm_class_procedure_class;
-extern SCM scm_class_operator_class, scm_class_operator_with_setter_class;
-extern SCM scm_class_entity_class;
-extern SCM scm_class_number, scm_class_list;
-extern SCM scm_class_keyword;
-extern SCM scm_class_port, scm_class_input_output_port;
-extern SCM scm_class_input_port, scm_class_output_port;
-extern SCM scm_class_foreign_class, scm_class_foreign_object;
-extern SCM scm_class_foreign_slot;
-extern SCM scm_class_self, scm_class_protected;
-extern SCM scm_class_opaque, scm_class_read_only;
-extern SCM scm_class_protected_opaque, scm_class_protected_read_only;
-extern SCM scm_class_scm;
-extern SCM scm_class_int, scm_class_float, scm_class_double;
-extern const char *scm_s_slot_set_x;
-
-extern SCM scm_module_goops;
-
-SCM scm_goops_version (void);
-SCM scm_oldfmt (SCM);
-char *scm_c_oldfmt0 (char *);
-char *scm_c_oldfmt (char *, int n);
-void scm_load_goops (void);
-SCM scm_make_foreign_object (SCM cls, SCM initargs);
-SCM scm_make_class (SCM meta, char *s_name, SCM supers, size_t size,
-                   void * (*constructor) (SCM initargs),
-                   size_t (*destructor) (void *));
-void scm_add_slot (SCM c, char *slot, SCM slot_class,
-                  SCM (*getter) (SCM obj),
-                  SCM (*setter) (SCM obj, SCM x),
-                  char *accessor_name);
-SCM scm_wrap_object (SCM c, void *);
-SCM scm_wrap_component (SCM c, SCM obj, void *);
-SCM scm_ensure_accessor (SCM name);
-void scm_add_method (SCM gf, SCM m);
+SCM_API SCM scm_class_top;
+SCM_API SCM scm_class_object;
+SCM_API SCM scm_class_class;
+SCM_API SCM scm_class_entity;
+SCM_API SCM scm_class_entity_with_setter;
+SCM_API SCM scm_class_generic;
+SCM_API SCM scm_class_generic_with_setter;
+SCM_API SCM scm_class_method;
+SCM_API SCM scm_class_simple_method;
+SCM_API SCM scm_class_accessor;
+SCM_API SCM scm_class_procedure_class;
+SCM_API SCM scm_class_operator_class;
+SCM_API SCM scm_class_operator_with_setter_class;
+SCM_API SCM scm_class_entity_class;
+SCM_API SCM scm_class_number;
+SCM_API SCM scm_class_list;
+SCM_API SCM scm_class_keyword;
+SCM_API SCM scm_class_port;
+SCM_API SCM scm_class_input_output_port;
+SCM_API SCM scm_class_input_port;
+SCM_API SCM scm_class_output_port;
+SCM_API SCM scm_class_foreign_class;
+SCM_API SCM scm_class_foreign_object;
+SCM_API SCM scm_class_foreign_slot;
+SCM_API SCM scm_class_self;
+SCM_API SCM scm_class_protected;
+SCM_API SCM scm_class_opaque;
+SCM_API SCM scm_class_read_only;
+SCM_API SCM scm_class_protected_opaque;
+SCM_API SCM scm_class_protected_read_only;
+SCM_API SCM scm_class_scm;
+SCM_API SCM scm_class_int;
+SCM_API SCM scm_class_float;
+SCM_API SCM scm_class_double;
+SCM_API const char *scm_s_slot_set_x;
+
+SCM_API SCM scm_module_goops;
+
+SCM_API SCM scm_goops_version (void);
+SCM_API SCM scm_oldfmt (SCM);
+SCM_API char *scm_c_oldfmt0 (char *);
+SCM_API char *scm_c_oldfmt (char *, int n);
+SCM_API void scm_load_goops (void);
+SCM_API SCM scm_make_foreign_object (SCM cls, SCM initargs);
+SCM_API SCM scm_make_class (SCM meta, char *s_name, SCM supers, size_t size,
+                           void * (*constructor) (SCM initargs),
+                           size_t (*destructor) (void *));
+SCM_API void scm_add_slot (SCM c, char *slot, SCM slot_class,
+                          SCM (*getter) (SCM obj),
+                          SCM (*setter) (SCM obj, SCM x),
+                          char *accessor_name);
+SCM_API SCM scm_wrap_object (SCM c, void *);
+SCM_API SCM scm_wrap_component (SCM c, SCM obj, void *);
+SCM_API SCM scm_ensure_accessor (SCM name);
+SCM_API void scm_add_method (SCM gf, SCM m);
 
 /* Low level functions exported */
-SCM scm_make_next_method (SCM methods, SCM args, SCM gf);
-SCM scm_basic_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
-SCM scm_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
+SCM_API SCM scm_make_next_method (SCM methods, SCM args, SCM gf);
+SCM_API SCM scm_basic_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
+SCM_API SCM scm_basic_make_class (SCM c, SCM name, SCM dsupers, SCM dslots);
 
 /* Primitives exported */
-SCM scm_sys_allocate_instance (SCM c, SCM initargs);
-SCM scm_sys_set_object_setter_x (SCM obj, SCM setter);
-SCM scm_slot_ref (SCM obj, SCM slot_name);
-SCM scm_slot_set_x (SCM obj, SCM slot_name, SCM value);
-
-SCM scm_compute_applicable_methods (SCM gf, SCM args, int len, int scm_find_method);
-SCM scm_sys_compute_applicable_methods (SCM gf, SCM args);
-SCM scm_m_atslot_ref (SCM xorig, SCM env);
-SCM scm_m_atslot_set_x (SCM xorig, SCM env);
-SCM scm_m_atdispatch (SCM xorig, SCM env);
+SCM_API SCM scm_sys_allocate_instance (SCM c, SCM initargs);
+SCM_API SCM scm_sys_set_object_setter_x (SCM obj, SCM setter);
+SCM_API SCM scm_slot_ref (SCM obj, SCM slot_name);
+SCM_API SCM scm_slot_set_x (SCM obj, SCM slot_name, SCM value);
+
+SCM_API SCM scm_compute_applicable_methods (SCM gf, SCM args, long len, int scm_find_method);
+SCM_API SCM scm_sys_compute_applicable_methods (SCM gf, SCM args);
+SCM_API SCM scm_m_atslot_ref (SCM xorig, SCM env);
+SCM_API SCM scm_m_atslot_set_x (SCM xorig, SCM env);
+SCM_API SCM scm_m_atdispatch (SCM xorig, SCM env);
 #ifdef GUILE_DEBUG
-SCM scm_pure_generic_p (SCM obj);
+SCM_API SCM scm_pure_generic_p (SCM obj);
 #endif
-extern void scm_init_oop_goops_goopscore_module (void);
-
-SCM scm_sys_compute_slots (SCM c); 
-SCM scm_i_get_keyword (SCM key, SCM l, int len, SCM default_value, const char *subr); 
-SCM scm_get_keyword (SCM key, SCM l, SCM default_value); 
-SCM scm_sys_initialize_object (SCM obj, SCM initargs); 
-SCM scm_sys_prep_layout_x (SCM c); 
-SCM scm_sys_inherit_magic_x (SCM c, SCM dsupers); 
-SCM scm_instance_p (SCM obj); 
-SCM scm_class_name (SCM obj); 
-SCM scm_class_direct_supers (SCM obj); 
-SCM scm_class_direct_slots (SCM obj); 
-SCM scm_class_direct_subclasses (SCM obj); 
-SCM scm_class_direct_methods (SCM obj); 
-SCM scm_class_precedence_list (SCM obj); 
-SCM scm_class_slots (SCM obj); 
-SCM scm_class_environment (SCM obj); 
-SCM scm_generic_function_name (SCM obj); 
-SCM scm_generic_function_methods (SCM obj); 
-SCM scm_method_generic_function (SCM obj); 
-SCM scm_method_specializers (SCM obj); 
-SCM scm_method_procedure (SCM obj); 
-SCM scm_accessor_method_slot_definition (SCM obj);
-SCM scm_sys_tag_body (SCM body);
-SCM scm_sys_fast_slot_ref (SCM obj, SCM index); 
-SCM scm_sys_fast_slot_set_x (SCM obj, SCM index, SCM value); 
-SCM scm_slot_ref_using_class (SCM cls, SCM obj, SCM slot_name); 
-SCM scm_slot_set_using_class_x (SCM cls, SCM obj, SCM slot_name, SCM value); 
-SCM scm_slot_bound_using_class_p (SCM cls, SCM obj, SCM slot_name); 
-SCM scm_slot_exists_using_class_p (SCM cls, SCM obj, SCM slot_name); 
-SCM scm_slot_bound_p (SCM obj, SCM slot_name); 
-SCM scm_slots_exists_p (SCM obj, SCM slot_name); 
-SCM scm_sys_modify_instance (SCM old, SCM newinst); 
-SCM scm_sys_modify_class (SCM old, SCM newcls);
-SCM scm_sys_invalidate_class (SCM cls);
-SCM scm_make_method_cache (SCM gf);
-SCM scm_sys_invalidate_method_cache_x (SCM gf);
-SCM scm_generic_capability_p (SCM proc);
-SCM scm_enable_primitive_generic_x (SCM subrs);
-SCM scm_primitive_generic_generic (SCM subr);
-SCM stklos_version (void); 
-SCM scm_make (SCM args); 
-SCM scm_find_method (SCM args); 
-SCM scm_sys_method_more_specific_p (SCM m1, SCM m2, SCM targs); 
-void scm_init_goops (void); 
-
-#endif /* GOOPSH */
+
+SCM_API SCM scm_sys_compute_slots (SCM c); 
+SCM_API SCM scm_i_get_keyword (SCM key, SCM l, long len, SCM default_value, const char *subr); 
+SCM_API SCM scm_get_keyword (SCM key, SCM l, SCM default_value); 
+SCM_API SCM scm_sys_initialize_object (SCM obj, SCM initargs); 
+SCM_API SCM scm_sys_prep_layout_x (SCM c); 
+SCM_API SCM scm_sys_inherit_magic_x (SCM c, SCM dsupers); 
+SCM_API SCM scm_instance_p (SCM obj); 
+SCM_API SCM scm_class_name (SCM obj); 
+SCM_API SCM scm_class_direct_supers (SCM obj); 
+SCM_API SCM scm_class_direct_slots (SCM obj); 
+SCM_API SCM scm_class_direct_subclasses (SCM obj); 
+SCM_API SCM scm_class_direct_methods (SCM obj); 
+SCM_API SCM scm_class_precedence_list (SCM obj); 
+SCM_API SCM scm_class_slots (SCM obj); 
+SCM_API SCM scm_class_environment (SCM obj); 
+SCM_API SCM scm_generic_function_name (SCM obj); 
+SCM_API SCM scm_generic_function_methods (SCM obj); 
+SCM_API SCM scm_method_generic_function (SCM obj); 
+SCM_API SCM scm_method_specializers (SCM obj); 
+SCM_API SCM scm_method_procedure (SCM obj); 
+SCM_API SCM scm_accessor_method_slot_definition (SCM obj);
+SCM_API SCM scm_sys_tag_body (SCM body);
+SCM_API SCM scm_sys_fast_slot_ref (SCM obj, SCM index); 
+SCM_API SCM scm_sys_fast_slot_set_x (SCM obj, SCM index, SCM value); 
+SCM_API SCM scm_slot_ref_using_class (SCM cls, SCM obj, SCM slot_name); 
+SCM_API SCM scm_slot_set_using_class_x (SCM cls, SCM obj, SCM slot_name, SCM value); 
+SCM_API SCM scm_slot_bound_using_class_p (SCM cls, SCM obj, SCM slot_name); 
+SCM_API SCM scm_slot_exists_using_class_p (SCM cls, SCM obj, SCM slot_name); 
+SCM_API SCM scm_slot_bound_p (SCM obj, SCM slot_name); 
+SCM_API SCM scm_slots_exists_p (SCM obj, SCM slot_name); 
+SCM_API SCM scm_sys_modify_instance (SCM old, SCM newinst); 
+SCM_API SCM scm_sys_modify_class (SCM old, SCM newcls);
+SCM_API SCM scm_sys_invalidate_class (SCM cls);
+SCM_API SCM scm_make_method_cache (SCM gf);
+SCM_API SCM scm_sys_invalidate_method_cache_x (SCM gf);
+SCM_API SCM scm_generic_capability_p (SCM proc);
+SCM_API SCM scm_enable_primitive_generic_x (SCM subrs);
+SCM_API SCM scm_primitive_generic_generic (SCM subr);
+SCM_API SCM stklos_version (void); 
+SCM_API SCM scm_make (SCM args); 
+SCM_API SCM scm_find_method (SCM args); 
+SCM_API SCM scm_sys_method_more_specific_p (SCM m1, SCM m2, SCM targs); 
+
+SCM_API SCM scm_init_goops_builtins (void);
+SCM_API void scm_init_goops (void); 
+
+#if (SCM_ENABLE_DEPRECATED == 1)
+
+#define SCM_INST_TYPE(x)       SCM_OBJ_CLASS_FLAGS (x)
+#define SCM_SIMPLEMETHODP(x) \
+  (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) & SCM_CLASSF_SIMPLE_METHOD))
+#define SCM_FASTMETHODP(x) \
+  (SCM_STRUCTP (x) && (SCM_STRUCT_VTABLE_FLAGS (x) \
+                       & (SCM_CLASSF_ACCESSOR_METHOD \
+                         | SCM_CLASSF_SIMPLE_METHOD)))
+
+
+#endif
+
+#endif /* SCM_GOOPS_H */