The FSF has a new address.
[bpt/guile.git] / libguile / goops.h
index d0b85c6..64da26f 100644 (file)
@@ -2,46 +2,24 @@
 
 #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
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
+
+/* Copyright (C) 1998,1999,2000,2001,2002,2003 Free Software Foundation, Inc.
  *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  */
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
 \f
 
 /* This software is a derivative work of other copyrighted softwares; the
 #define SCM_CLASS_CLASS_LAYOUT "prsrpwpopopwururururururururpwpwpwpwpwpwpwpwpwpwpwpw"
 
 #define scm_si_layout            0 /* the struct layout */
-#define scm_si_vtable            1 
+#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_setter            4
 
 #define scm_si_goops_fields      5
 
 #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_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_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
@@ -121,40 +99,40 @@ typedef struct scm_t_method {
 #define SCM_CLASS_OF(x)        SCM_STRUCT_VTABLE (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_DATA (x)[scm_struct_i_n_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_VALIDATE_CLASS(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, CLASSP, "class")
 
 #define SCM_INSTANCEP(x) \
   (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_VALIDATE_INSTANCE(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, INSTANCEP, "instance")
 
 #define SCM_PUREGENERICP(x) \
   (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_VALIDATE_PUREGENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, PUREGENERICP, "pure generic function")
 
 #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_VALIDATE_ACCESSOR(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, ACCESSORP, "accessor")
 
 #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_INSTANCE_HASH(c, i) (SCM_INST (c) [scm_si_hashsets + (i)])
 #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_SUBCLASSP(c1, c2)  (scm_is_true (scm_c_memq (c2, SCM_SLOT (c1, scm_si_cpl))))
 #define SCM_IS_A_P(x, c) \
   (SCM_INSTANCEP (x) && SCM_SUBCLASSP (SCM_CLASS_OF (x), c))
 
 #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_VALIDATE_GENERIC(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, GENERICP, "generic function")
 
 #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_VALIDATE_METHOD(pos, x) SCM_MAKE_VALIDATE_MSG (pos, x, METHODP, "method")
 
 #define SCM_MCACHE_N_SPECIALIZED(C) SCM_CADDR (C)
 #define SCM_SET_MCACHE_N_SPECIALIZED(C, X) SCM_SETCAR (SCM_CDDR (C), X)
@@ -178,113 +156,151 @@ typedef struct scm_t_method {
 #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_boolean;
+SCM_API SCM scm_class_char;
+SCM_API SCM scm_class_pair;
+SCM_API SCM scm_class_procedure;
+SCM_API SCM scm_class_string;
+SCM_API SCM scm_class_symbol;
+SCM_API SCM scm_class_procedure_with_setter;
+SCM_API SCM scm_class_primitive_generic;
+SCM_API SCM scm_class_vector, scm_class_null;
+SCM_API SCM scm_class_real;
+SCM_API SCM scm_class_complex;
+SCM_API SCM scm_class_integer;
+SCM_API SCM scm_class_fraction;
+SCM_API SCM scm_class_unknown;
+SCM_API SCM *scm_port_class;
+SCM_API SCM *scm_smob_class;
+SCM_API SCM scm_class_top;
+SCM_API SCM scm_class_object;
+SCM_API SCM scm_class_class;
+SCM_API SCM scm_class_applicable;
+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_accessor;
+SCM_API SCM scm_class_extended_generic;
+SCM_API SCM scm_class_extended_generic_with_setter;
+SCM_API SCM scm_class_extended_accessor;
+SCM_API SCM scm_class_method;
+SCM_API SCM scm_class_simple_method;
+SCM_API SCM scm_class_accessor_method;
+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_no_applicable_method;
+
+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);
+SCM_API SCM scm_class_of (SCM obj);
 
 /* 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, long 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);
 #ifdef GUILE_DEBUG
-SCM scm_pure_generic_p (SCM obj);
+SCM_API SCM scm_pure_generic_p (SCM obj);
 #endif
 
-SCM scm_sys_compute_slots (SCM c); 
-SCM scm_i_get_keyword (SCM key, SCM l, long 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); 
-
-SCM scm_init_goops_builtins (void);
-void scm_init_goops (void); 
-
-#if (SCM_DEBUG_DEPRECATED == 0)
+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_slot_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 void scm_c_extend_primitive_generic (SCM subr, SCM extension);
+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) \
@@ -297,4 +313,10 @@ void scm_init_goops (void);
 
 #endif
 
-#endif /* SCM_GOOPS_H */
+#endif  /* SCM_GOOPS_H */
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/