Only include strings.h where it is actually needed.
[bpt/guile.git] / libguile / struct.h
index 545a41c..9e7bfba 100644 (file)
@@ -2,7 +2,7 @@
 
 #ifndef STRUCTH
 #define STRUCTH
-/*     Copyright (C) 1995 Free Software Foundation, Inc.
+/*     Copyright (C) 1995, 1997, 1999, 2000 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
  * 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.  */
+
+/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
+   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
 \f
 
 #include "libguile/__scm.h"
+#include "libguile/print.h"
 
 \f
 
 /* Number of words with negative index */
-#define scm_struct_n_extra_words 3
+#define scm_struct_n_extra_words 4
+#define scm_struct_entity_n_extra_words 6
 
 /* These are how the initial words of a vtable are allocated. */
-#define scm_struct_i_ptr -3    /* start of block (see alloc_struct) */
-#define scm_struct_i_n_words -2        /* How many words allocated to this struct? */
-#define scm_struct_i_tag -1    /* A unique tag for this type.. */
-#define scm_struct_i_layout 0  /* A symbol describing the physical arrangement of this type. */
-#define scm_struct_i_vcell 1   /* An opaque word, managed by the garbage collector.  */
-#define scm_struct_i_vtable 2  /* A pointer to the handle for this vtable. */
-#define scm_struct_i_vtable_offset 3 /* Where do user fields start? */
+#define scm_struct_i_setter    -6 /* Setter */
+#define scm_struct_i_procedure -5 /* Optional procedure slot */
+#define scm_struct_i_free      -4 /* Destructor */
+#define scm_struct_i_ptr       -3 /* Start of block (see alloc_struct) */
+#define scm_struct_i_n_words   -2 /* How many words allocated to this struct? */
+#define scm_struct_i_size      -1 /* Instance size */
+#define scm_struct_i_flags     -1 /* Upper 12 bits used as flags */
+#define scm_vtable_index_layout  0 /* A symbol describing the physical arrangement of this type. */
+#define scm_vtable_index_vcell   1 /* An opaque word, managed by the garbage collector.  */
+#define scm_vtable_index_vtable  2 /* A pointer to the handle for this vtable. */
+#define scm_vtable_index_printer 3 /* A printer for this struct type. */
+#define scm_vtable_offset_user   4 /* Where do user fields start? */
+
+typedef scm_sizet (*scm_struct_free_t) (SCM *vtable, SCM *data);
 
+#define SCM_STRUCTF_MASK   (0xFFF << 20)
+#define SCM_STRUCTF_ENTITY (1L << 30) /* Indicates presence of proc slots */
+#define SCM_STRUCTF_LIGHT  (1L << 31) /* Light representation
+                                        (no hidden words) */
 
-#define SCM_STRUCTP(X)                 (SCM_TYP3(X) == scm_tc3_cons_gloc)
+#define SCM_STRUCTP(X)                 (SCM_NIMP(X) && (SCM_TYP3(X) == scm_tc3_cons_gloc))
 #define SCM_STRUCT_DATA(X)             ((SCM*)(SCM_CDR(X)))
-#define SCM_STRUCT_VTABLE_DATA(X)      ((SCM *)(SCM_CAR(X) - 1))
-#define SCM_STRUCT_LAYOUT(X)           (SCM_STRUCT_VTABLE_DATA(X)[scm_struct_i_layout])
-#define SCM_STRUCT_VTABLE(X)           (SCM_STRUCT_VTABLE_DATA(X)[scm_struct_i_vtable])
+#define SCM_STRUCT_VTABLE_DATA(X)      ((SCM *)(SCM_UNPACK (SCM_CAR(X)) - 1))
+#define SCM_STRUCT_LAYOUT(X)           (SCM_STRUCT_VTABLE_DATA(X)[scm_vtable_index_layout])
+#define SCM_STRUCT_VTABLE(X)           (SCM_STRUCT_VTABLE_DATA(X)[scm_vtable_index_vtable])
+#define SCM_STRUCT_PRINTER(X)          (SCM_STRUCT_VTABLE_DATA(X)[scm_vtable_index_printer])
+#define SCM_SET_VTABLE_DESTRUCTOR(X, D) (SCM_STRUCT_DATA(X)[scm_struct_i_free] = (SCM) D)
 /* Efficiency is important in the following macro, since it's used in GC */
 #define SCM_LAYOUT_TAILP(X)            (((X) & 32) == 0) /* R, W or O */
 
+#define SCM_STRUCT_TABLE_NAME(X) SCM_CAR (X)
+#define SCM_SET_STRUCT_TABLE_NAME(X, NAME) SCM_SETCAR (X, NAME)
+#define SCM_STRUCT_TABLE_CLASS(X) SCM_CDR (X)
+#define SCM_SET_STRUCT_TABLE_CLASS(X, CLASS) SCM_SETCDR (X, CLASS)
+extern SCM scm_struct_table;
 
 \f
 
-extern SCM scm_make_struct_layout SCM_P ((SCM fields));
-extern SCM scm_struct_p SCM_P ((SCM x));
-extern SCM scm_struct_vtable_p SCM_P ((SCM x));
-extern SCM scm_make_struct SCM_P ((SCM vtable, SCM tail_array_size, SCM init));
-extern SCM scm_make_vtable_vtable SCM_P ((SCM extra_fields, SCM tail_array_size, SCM init));
-extern SCM scm_struct_ref SCM_P ((SCM handle, SCM pos));
-extern SCM scm_struct_set_x SCM_P ((SCM handle, SCM pos, SCM val));
-extern SCM scm_struct_vtable SCM_P ((SCM handle));
-extern SCM scm_struct_vtable_tag SCM_P ((SCM handle));
-extern void scm_init_struct SCM_P ((void));
+extern SCM *scm_alloc_struct (int n_words,
+                             int n_extra,
+                             char *who);
+extern scm_sizet scm_struct_free_0 (SCM *vtable, SCM *data);
+extern scm_sizet scm_struct_free_light (SCM *vtable, SCM *data);
+extern scm_sizet scm_struct_free_standard (SCM *vtable, SCM *data);
+extern scm_sizet scm_struct_free_entity (SCM *vtable, SCM *data);
+extern void scm_struct_init (SCM handle, int tail_elts, SCM inits);
+extern SCM scm_make_struct_layout (SCM fields);
+extern SCM scm_struct_p (SCM x);
+extern SCM scm_struct_vtable_p (SCM x);
+extern SCM scm_make_struct (SCM vtable, SCM tail_array_size, SCM init);
+extern SCM scm_make_vtable_vtable (SCM extra_fields, SCM tail_array_size, SCM init);
+extern SCM scm_struct_ref (SCM handle, SCM pos);
+extern SCM scm_struct_set_x (SCM handle, SCM pos, SCM val);
+extern SCM scm_struct_vtable (SCM handle);
+extern SCM scm_struct_vtable_tag (SCM handle);
+extern unsigned int scm_struct_ihashq (SCM obj, unsigned int n);
+extern SCM scm_struct_create_handle (SCM obj);
+extern SCM scm_struct_vtable_name (SCM vtable);
+extern SCM scm_set_struct_vtable_name_x (SCM vtable, SCM name);
+extern void scm_print_struct (SCM exp, SCM port, scm_print_state *);
+extern void scm_init_struct (void);
 
 #endif  /* STRUCTH */