2002-07-20 Han-Wen <hanwen@cs.uu.nl>
[bpt/guile.git] / libguile / struct.c
index 26c0c11..e858589 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (C) 1996, 97, 98, 99, 2000 Free Software Foundation, Inc.
+/* Copyright (C) 1996,1997,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
  * 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 <stdio.h>
-#include "_scm.h"
-#include "chars.h"
-#include "genio.h"
-#include "eval.h"
-#include "alist.h"
-#include "weaks.h"
-#include "hashtab.h"
+#include "libguile/_scm.h"
+#include "libguile/chars.h"
+#include "libguile/eval.h"
+#include "libguile/alist.h"
+#include "libguile/weaks.h"
+#include "libguile/hashtab.h"
+#include "libguile/ports.h"
+#include "libguile/strings.h"
 
-#include "validate.h"
-#include "struct.h"
+#include "libguile/validate.h"
+#include "libguile/struct.h"
 
 #ifdef HAVE_STRING_H
 #include <string.h>
@@ -69,26 +67,30 @@ SCM scm_struct_table;
 SCM_DEFINE (scm_make_struct_layout, "make-struct-layout", 1, 0, 0, 
             (SCM fields),
            "Return a new structure layout object.\n\n"
-           "@var{fields} must be a read-only string made up of pairs of characters\n"
+           "@var{fields} must be a string made up of pairs of characters\n"
            "strung together.  The first character of each pair describes a field\n"
            "type, the second a field protection.  Allowed types are 'p' for\n"
            "GC-protected Scheme data, 'u' for unprotected binary data, and 's' for\n"
-           "fields that should point to the structure itself.    Allowed protections\n"
-           "are 'w' for mutable fields, 'r' for read-only fields, and 'o' for opaque \n"
+           "a field that points to the structure itself.    Allowed protections\n"
+           "are 'w' for mutable fields, 'r' for read-only fields, and 'o' for opaque\n"
            "fields.  The last field protection specification may be capitalized to\n"
            "indicate that the field is a tail-array.")
 #define FUNC_NAME s_scm_make_struct_layout
 {
   SCM new_sym;
-  SCM_VALIDATE_ROSTRING (1,fields);
+  SCM_VALIDATE_STRING (1, fields);
+
   { /* scope */
     char * field_desc;
-    int len;
+    size_t len;
     int x;
 
-    len = SCM_ROLENGTH (fields);
-    field_desc = SCM_ROCHARS (fields);
-    SCM_ASSERT (!(len & 1), fields, "odd length field specification", FUNC_NAME);
+    len = SCM_STRING_LENGTH (fields);
+    if (len % 2 == 1)
+      SCM_MISC_ERROR ("odd length field specification: ~S", 
+                     scm_list_1 (fields));
+
+    field_desc = SCM_STRING_CHARS (fields);
 
     for (x = 0; x < len; x += 2)
       {
@@ -103,41 +105,44 @@ SCM_DEFINE (scm_make_struct_layout, "make-struct-layout", 1, 0, 0,
          case 's':
            break;
          default:
-           SCM_ASSERT (0, SCM_MAKE_CHAR (field_desc[x]) , "unrecognized field type", FUNC_NAME);
+           SCM_MISC_ERROR ("unrecognized field type: ~S", 
+                           scm_list_1 (SCM_MAKE_CHAR (field_desc[x])));
          }
 
        switch (field_desc[x + 1])
          {
          case 'w':
-           SCM_ASSERT (field_desc[x] != 's', SCM_MAKE_CHAR (field_desc[x + 1]),
-                       "self fields not writable", FUNC_NAME);
-             
+           if (field_desc[x] == 's')
+             SCM_MISC_ERROR ("self fields not writable", SCM_EOL);
          case 'r':
          case 'o':
            break;
          case 'R':
          case 'W':
          case 'O':
-           SCM_ASSERT (field_desc[x] != 's', SCM_MAKE_CHAR (field_desc[x + 1]),
-                       "self fields not allowed in tail array",
-                        FUNC_NAME);
-           SCM_ASSERT (x == len - 2, SCM_MAKE_CHAR (field_desc[x + 1]),
-                       "tail array field must be last field in layout",
-                        FUNC_NAME);
+           if (field_desc[x] == 's')
+             SCM_MISC_ERROR ("self fields not allowed in tail array", 
+                             SCM_EOL);
+           if (x != len - 2)
+             SCM_MISC_ERROR ("tail array field must be last field in layout",
+                             SCM_EOL);
            break;
          default:
-           SCM_ASSERT (0, SCM_MAKE_CHAR (field_desc[x]) , "unrecognized ref specification", FUNC_NAME);
+           SCM_MISC_ERROR ("unrecognized ref specification: ~S",
+                           scm_list_1 (SCM_MAKE_CHAR (field_desc[x + 1])));
          }
 #if 0
        if (field_desc[x] == 'd')
          {
-           SCM_ASSERT (field_desc[x + 2] == '-', SCM_MAKINUM (x / 2), "missing dash field", FUNC_NAME);
+           if (field_desc[x + 2] != '-')
+             SCM_MISC_ERROR ("missing dash field at position ~A",
+                             scm_list_1 (SCM_MAKINUM (x / 2)));
            x += 2;
            goto recheck_ref;
          }
 #endif
       }
-    new_sym = SCM_CAR (scm_intern_obarray (field_desc, len, SCM_BOOL_F));
+    new_sym = scm_mem2symbol (field_desc, len);
   }
   return scm_return_first (new_sym, fields);
 }
@@ -147,22 +152,14 @@ SCM_DEFINE (scm_make_struct_layout, "make-struct-layout", 1, 0, 0,
 
 
 
-void
-scm_struct_init (SCM handle, int tail_elts, SCM inits)
+static void
+scm_struct_init (SCM handle, SCM layout, scm_t_bits * mem, int tail_elts, SCM inits)
 {
-  SCM layout;
-  SCM * data;
-  unsigned char * fields_desc;
+  unsigned char * fields_desc = (unsigned char *) SCM_SYMBOL_CHARS (layout) - 2;
   unsigned char prot = 0;
-  int n_fields;
-  SCM * mem;
+  int n_fields = SCM_SYMBOL_LENGTH (layout) / 2;
   int tailp = 0;
-  
-  layout = SCM_STRUCT_LAYOUT (handle);
-  data = SCM_STRUCT_DATA (handle);
-  fields_desc = (unsigned char *) SCM_CHARS (layout) - 2;
-  n_fields = SCM_LENGTH (layout) / 2;
-  mem = SCM_STRUCT_DATA (handle);
+
   while (n_fields)
     {
       if (!tailp)
@@ -173,7 +170,7 @@ scm_struct_init (SCM handle, int tail_elts, SCM inits)
            {
              tailp = 1;
              prot = prot == 'R' ? 'r' : prot == 'W' ? 'w' : 'o';
-             *mem++ = SCM_PACK (tail_elts);
+             *mem++ = tail_elts;
              n_fields += tail_elts - 1;
              if (n_fields == 0)
                break;
@@ -195,23 +192,23 @@ scm_struct_init (SCM handle, int tail_elts, SCM inits)
 #endif
 
        case 'u':
-         if ((prot != 'r' && prot != 'w') || inits == SCM_EOL)
+         if ((prot != 'r' && prot != 'w') || SCM_NULLP (inits))
            *mem = 0;
          else
            {
-             *mem = SCM_PACK (scm_num2ulong (SCM_CAR (inits),
-                                              SCM_ARGn,
-                                              "scm_struct_init"));
+             *mem = scm_num2ulong (SCM_CAR (inits),
+                                   SCM_ARGn,
+                                   "scm_struct_init");
              inits = SCM_CDR (inits);
            }
          break;
 
        case 'p':
-         if ((prot != 'r' && prot != 'w') || inits == SCM_EOL)
-           *mem = SCM_BOOL_F;
+         if ((prot != 'r' && prot != 'w') || SCM_NULLP (inits))
+           *mem = SCM_UNPACK (SCM_BOOL_F);
          else
            {
-             *mem = SCM_CAR (inits);
+             *mem = SCM_UNPACK (SCM_CAR (inits));
              inits = SCM_CDR (inits);
            }
              
@@ -231,7 +228,7 @@ scm_struct_init (SCM handle, int tail_elts, SCM inits)
 #endif
 
        case 's':
-         *mem = handle;
+         *mem = SCM_UNPACK (handle);
          break;
        }
 
@@ -243,7 +240,8 @@ scm_struct_init (SCM handle, int tail_elts, SCM inits)
 
 SCM_DEFINE (scm_struct_p, "struct?", 1, 0, 0, 
             (SCM x),
-           "Return #t iff @var{obj} is a structure object, else #f.")
+           "Return @code{#t} iff @var{x} is a structure object, else\n"
+           "@code{#f}.")
 #define FUNC_NAME s_scm_struct_p
 {
   return SCM_BOOL(SCM_STRUCTP (x));
@@ -252,36 +250,27 @@ SCM_DEFINE (scm_struct_p, "struct?", 1, 0, 0,
 
 SCM_DEFINE (scm_struct_vtable_p, "struct-vtable?", 1, 0, 0, 
             (SCM x),
-           "Return #t iff obj is a vtable structure.")
+           "Return @code{#t} iff @var{x} is a vtable structure.")
 #define FUNC_NAME s_scm_struct_vtable_p
 {
   SCM layout;
-  SCM * mem;
-
-  if (SCM_IMP (x))
-    return SCM_BOOL_F;
+  scm_t_bits * mem;
 
   if (!SCM_STRUCTP (x))
     return SCM_BOOL_F;
 
   layout = SCM_STRUCT_LAYOUT (x);
 
-  if (SCM_LENGTH (layout) < SCM_LENGTH (required_vtable_fields))
+  if (SCM_SYMBOL_LENGTH (layout) < SCM_STRING_LENGTH (required_vtable_fields))
     return SCM_BOOL_F;
 
-  if (strncmp (SCM_CHARS (layout), SCM_CHARS (required_vtable_fields),
-              SCM_LENGTH (required_vtable_fields)))
+  if (strncmp (SCM_SYMBOL_CHARS (layout), SCM_STRING_CHARS (required_vtable_fields),
+              SCM_STRING_LENGTH (required_vtable_fields)))
     return SCM_BOOL_F;
 
   mem = SCM_STRUCT_DATA (x);
 
-  if (mem[1] != 0)
-    return SCM_BOOL_F;
-
-  if (SCM_IMP (mem[0]))
-    return SCM_BOOL_F;
-
-  return SCM_BOOL(SCM_SYMBOLP (mem[0]));
+  return SCM_BOOL (SCM_SYMBOLP (SCM_PACK (mem[scm_vtable_index_layout])));
 }
 #undef FUNC_NAME
 
@@ -316,101 +305,165 @@ SCM_DEFINE (scm_struct_vtable_p, "struct-vtable?", 1, 0, 0,
      Ugh.  */
 
 
-SCM *
-scm_alloc_struct (int n_words, int n_extra, char *who)
+scm_t_bits *
+scm_alloc_struct (int n_words, int n_extra, const char *what)
 {
-  int size = sizeof (SCM) * (n_words + n_extra) + 7;
-  SCM *block = (SCM *) scm_must_malloc (size, who);
+  int size = sizeof (scm_t_bits) * (n_words + n_extra) + 7;
+  void * block = scm_gc_malloc (size, what);
 
   /* Adjust the pointer to hide the extra words.  */
-  SCM *p = block + n_extra;
+  scm_t_bits * p = (scm_t_bits *) block + n_extra;
 
   /* Adjust it even further so it's aligned on an eight-byte boundary.  */
-  p = (SCM *) (((scm_bits_t) SCM_UNPACK (p) + 7) & ~7);
+  p = (scm_t_bits *) (((scm_t_bits) p + 7) & ~7);
 
   /* Initialize a few fields as described above.  */
-  p[scm_struct_i_free] = (SCM) scm_struct_free_standard;
-  p[scm_struct_i_ptr] = (SCM) block;
-  p[scm_struct_i_n_words] = (SCM) n_words;
+  p[scm_struct_i_free] = (scm_t_bits) scm_struct_free_standard;
+  p[scm_struct_i_ptr] = (scm_t_bits) block;
+  p[scm_struct_i_n_words] = n_words;
   p[scm_struct_i_flags] = 0;
 
   return p;
 }
 
-scm_sizet
-scm_struct_free_0 (SCM *vtable, SCM *data)
+void
+scm_struct_free_0 (scm_t_bits * vtable SCM_UNUSED,
+                  scm_t_bits * data SCM_UNUSED)
 {
-  return 0;
 }
 
-scm_sizet
-scm_struct_free_light (SCM *vtable, SCM *data)
+void
+scm_struct_free_light (scm_t_bits * vtable, scm_t_bits * data)
+{
+  size_t n = vtable [scm_struct_i_size] & ~SCM_STRUCTF_MASK;
+  scm_gc_free (data, n, "struct");
+}
+
+void
+scm_struct_free_standard (scm_t_bits * vtable SCM_UNUSED, scm_t_bits * data)
+{
+  size_t n = (data[scm_struct_i_n_words] + scm_struct_n_extra_words)
+            * sizeof (scm_t_bits) + 7;
+  scm_gc_free ((void *) data[scm_struct_i_ptr], n, "heavy struct");
+}
+
+void
+scm_struct_free_entity (scm_t_bits * vtable SCM_UNUSED, scm_t_bits * data)
 {
-  free (data);
-  return SCM_UNPACK (vtable[scm_struct_i_size]) & ~SCM_STRUCTF_MASK;
+  size_t n = (data[scm_struct_i_n_words] + scm_struct_entity_n_extra_words)
+            * sizeof (scm_t_bits) + 7;
+  scm_gc_free ((void *) data[scm_struct_i_ptr], n, "entity struct");
 }
 
-scm_sizet
-scm_struct_free_standard (SCM *vtable, SCM *data)
+static void *
+scm_struct_gc_init (void *dummy1 SCM_UNUSED,
+                   void *dummy2 SCM_UNUSED,
+                   void *dummy3 SCM_UNUSED)
 {
-  size_t n = ((SCM_UNPACK (data[scm_struct_i_n_words]) + scm_struct_n_extra_words)
-             * sizeof (SCM) + 7);
-  free ((void *) data[scm_struct_i_ptr]);
-  return n;
+  scm_structs_to_free = SCM_EOL;
+  return 0;
 }
 
-scm_sizet
-scm_struct_free_entity (SCM *vtable, SCM *data)
+static void *
+scm_free_structs (void *dummy1 SCM_UNUSED,
+                 void *dummy2 SCM_UNUSED,
+                 void *dummy3 SCM_UNUSED)
 {
-  size_t n = (SCM_UNPACK(data[scm_struct_i_n_words] + scm_struct_entity_n_extra_words)
-             * sizeof (SCM) + 7);
-  free ((void *) data[scm_struct_i_ptr]);
-  return n;
+  SCM newchain = scm_structs_to_free;
+  do
+    {
+      /* Mark vtables in GC chain.  GC mark set means delay freeing. */
+      SCM chain = newchain;
+      while (!SCM_NULLP (chain))
+       {
+         SCM vtable = SCM_STRUCT_VTABLE (chain);
+         if (SCM_STRUCT_GC_CHAIN (vtable) != 0 && vtable != chain)
+           SCM_SETGCMARK (vtable);
+         chain = SCM_STRUCT_GC_CHAIN (chain);
+       }
+      /* Free unmarked structs.  */
+      chain = newchain;
+      newchain = SCM_EOL;
+      while (!SCM_NULLP (chain))
+       {
+         SCM obj = chain;
+         chain = SCM_STRUCT_GC_CHAIN (chain);
+         if (SCM_GCMARKP (obj))
+           {
+             SCM_CLRGCMARK (obj);
+             SCM_SET_STRUCT_GC_CHAIN (obj, newchain);
+             newchain = obj;
+           }
+         else
+           {
+             /* XXX - use less explicit code. */
+             scm_t_bits word0 = SCM_CELL_WORD_0 (obj) - scm_tc3_struct;
+             scm_t_bits * vtable_data = (scm_t_bits *) word0;
+             scm_t_bits * data = SCM_STRUCT_DATA (obj);
+             scm_t_struct_free free_struct_data
+               = ((scm_t_struct_free) vtable_data[scm_struct_i_free]);
+             SCM_SET_CELL_TYPE (obj, scm_tc_free_cell);
+             free_struct_data (vtable_data, data);
+           }
+       }
+    }
+  while (!SCM_NULLP (newchain));
+  return 0;
 }
 
 SCM_DEFINE (scm_make_struct, "make-struct", 2, 0, 1, 
             (SCM vtable, SCM tail_array_size, SCM init),
            "Create a new structure.\n\n"
-           "@var{type} must be a vtable structure (@xref{Vtables}).\n\n"
+           "@var{type} must be a vtable structure (@pxref{Vtables}).\n\n"
            "@var{tail-elts} must be a non-negative integer.  If the layout\n"
            "specification indicated by @var{type} includes a tail-array,\n"
            "this is the number of elements allocated to that array.\n\n"
-           "The @var{inits} are optional arguments describing how successive fields\n"
-           "of the structure should be initialized.  Only fields with protection 'r'\n"
-           "or 'w' can be initialized -- fields of protection 's' are automatically\n"
-           "initialized to point to the new structure itself;  fields of protection 'o'\n"
-           "can not be initialized by Scheme programs.")
+           "The @var{init1}, @dots{} are optional arguments describing how\n"
+           "successive fields of the structure should be initialized.  Only fields\n"
+           "with protection 'r' or 'w' can be initialized, except for fields of\n"
+           "type 's', which are automatically initialized to point to the new\n"
+           "structure itself; fields with protection 'o' can not be initialized by\n"
+           "Scheme programs.\n\n"
+           "If fewer optional arguments than initializable fields are supplied,\n"
+           "fields of type 'p' get default value #f while fields of type 'u' are\n"
+           "initialized to 0.\n\n"
+           "Structs are currently the basic representation for record-like data\n"
+           "structures in Guile.  The plan is to eventually replace them with a\n"
+           "new representation which will at the same time be easier to use and\n"
+           "more powerful.\n\n"
+           "For more information, see the documentation for @code{make-vtable-vtable}.")
 #define FUNC_NAME s_scm_make_struct
 {
   SCM layout;
   int basic_size;
   int tail_elts;
-  SCM * data;
+  scm_t_bits * data;
   SCM handle;
 
-  SCM_VALIDATE_VTABLE (1,vtable);
-  SCM_VALIDATE_INUM (2,tail_array_size);
+  SCM_VALIDATE_VTABLE (1, vtable);
+  SCM_VALIDATE_INUM (2, tail_array_size);
+  SCM_VALIDATE_REST_ARGUMENT (init);
 
-  layout = SCM_STRUCT_DATA (vtable)[scm_vtable_index_layout];
-  basic_size = SCM_LENGTH (layout) / 2;
+  layout = SCM_PACK (SCM_STRUCT_DATA (vtable) [scm_vtable_index_layout]);
+  basic_size = SCM_SYMBOL_LENGTH (layout) / 2;
   tail_elts = SCM_INUM (tail_array_size);
-  SCM_NEWCELL (handle);
   SCM_DEFER_INTS;
-  if (SCM_UNPACK (SCM_STRUCT_DATA (vtable)[scm_struct_i_flags]) & SCM_STRUCTF_ENTITY)
+  if (SCM_STRUCT_DATA (vtable)[scm_struct_i_flags] & SCM_STRUCTF_ENTITY)
     {
       data = scm_alloc_struct (basic_size + tail_elts,
                               scm_struct_entity_n_extra_words,
-                              "make-struct");
-      data[scm_struct_i_procedure] = SCM_BOOL_F;
-      data[scm_struct_i_setter] = SCM_BOOL_F;
+                              "entity struct");
+      data[scm_struct_i_procedure] = SCM_UNPACK (SCM_BOOL_F);
+      data[scm_struct_i_setter] = SCM_UNPACK (SCM_BOOL_F);
     }
   else
     data = scm_alloc_struct (basic_size + tail_elts,
                             scm_struct_n_extra_words,
-                            "make-struct");
-  SCM_SETCDR (handle, data);
-  SCM_SETCAR (handle, ((SCM)SCM_STRUCT_DATA (vtable)) + scm_tc3_cons_gloc);
-  scm_struct_init (handle, tail_elts, init);
+                            "struct");
+  handle = scm_double_cell ((((scm_t_bits) SCM_STRUCT_DATA (vtable))
+                            + scm_tc3_struct),
+                           (scm_t_bits) data, 0, 0);
+  scm_struct_init (handle, layout, data, tail_elts, init);
   SCM_ALLOW_INTS;
   return handle;
 }
@@ -419,88 +472,77 @@ SCM_DEFINE (scm_make_struct, "make-struct", 2, 0, 1,
 
 
 SCM_DEFINE (scm_make_vtable_vtable, "make-vtable-vtable", 2, 0, 1,
-            (SCM extra_fields, SCM tail_array_size, SCM init),
+            (SCM user_fields, SCM tail_array_size, SCM init),
            "Return a new, self-describing vtable structure.\n\n"
-           "@var{new-fields} is a layout specification describing fields\n"
-           "of the resulting structure beginning at the position bound to\n"
-           "@code{vtable-offset-user}.\n\n"
+           "@var{user-fields} is a string describing user defined fields of the\n"
+           "vtable beginning at index @code{vtable-offset-user}\n"
+           "(see @code{make-struct-layout}).\n\n"
            "@var{tail-size} specifies the size of the tail-array (if any) of\n"
            "this vtable.\n\n"
-           "@var{inits} initializes the fields of the vtable.  Minimally, one\n"
-           "initializer must be provided: the layout specification for instances\n"
-           "of the type this vtable will describe.  If a second initializer is\n"
-           "provided, it will be interpreted as a print call-back function.\n\n"
-           "@example\n"
-           ";;; loading ,a...\n"
-           "(define x\n"
-           "  (make-vtable-vtable (make-struct-layout (quote pw))\n"
-           "                      0\n"
-           "                      'foo))\n\n"
-           "(struct? x)\n"
-           "@result{} #t\n"
-           "(struct-vtable? x)\n"
-           "@result{} #t\n"
-           "(eq? x (struct-vtable x))\n"
-           "@result{} #t\n"
-           "(struct-ref x vtable-offset-user)\n"
-           "@result{} foo\n"
-           "(struct-ref x 0)\n"
-           "@result{} pruosrpwpw\n\n\n"
-           "(define y\n"
-           "  (make-struct x\n"
-           "               0\n"
-           "               (make-struct-layout (quote pwpwpw))\n"
-           "               'bar))\n\n"
-           "(struct? y)\n"
-           "@result{} #t\n"
-           "(struct-vtable? y)\n"
-           "@result{} #t\n"
-           "(eq? x y)\n"
-           "@result{} ()\n"
-           "(eq? x (struct-vtable y))\n"
-           "@result{} #t\n"
-           "(struct-ref y 0)\n"
-           "@result{} pwpwpw\n"
-           "(struct-ref y vtable-offset-user)\n"
-           "@result{} bar\n\n\n"
-           "(define z (make-struct y 0 'a 'b 'c))\n\n"
-           "(struct? z)\n"
-           "@result{} #t\n"
-           "(struct-vtable? z)\n"
-           "@result{} ()\n"
-           "(eq? y (struct-vtable z))\n"
-           "@result{} #t\n"
-           "(map (lambda (n) (struct-ref z n)) '(0 1 2))\n"
-           "@result{} (a b c)\n"
-           "@end example\n"
-           "")
+           "@var{init1}, @dots{} are the optional initializers for the fields of\n"
+           "the vtable.\n\n"
+           "Vtables have one initializable system field---the struct printer.\n"
+           "This field comes before the user fields in the initializers passed\n"
+           "to @code{make-vtable-vtable} and @code{make-struct}, and thus works as\n"
+           "a third optional argument to @code{make-vtable-vtable} and a fourth to\n"
+           "@code{make-struct} when creating vtables:\n\n"
+           "If the value is a procedure, it will be called instead of the standard\n"
+           "printer whenever a struct described by this vtable is printed.\n"
+           "The procedure will be called with arguments STRUCT and PORT.\n\n"
+           "The structure of a struct is described by a vtable, so the vtable is\n"
+           "in essence the type of the struct.  The vtable is itself a struct with\n"
+           "a vtable.  This could go on forever if it weren't for the\n"
+           "vtable-vtables which are self-describing vtables, and thus terminate\n"
+           "the chain.\n\n"
+           "There are several potential ways of using structs, but the standard\n"
+           "one is to use three kinds of structs, together building up a type\n"
+           "sub-system: one vtable-vtable working as the root and one or several\n"
+           "\"types\", each with a set of \"instances\".  (The vtable-vtable should be\n"
+           "compared to the class <class> which is the class of itself.)\n\n"
+           "@lisp\n"
+           "(define ball-root (make-vtable-vtable \"pr\" 0))\n\n"
+           "(define (make-ball-type ball-color)\n"
+           "  (make-struct ball-root 0\n"
+           "          (make-struct-layout \"pw\")\n"
+           "               (lambda (ball port)\n"
+           "                 (format port \"#<a ~A ball owned by ~A>\"\n"
+           "                         (color ball)\n"
+           "                         (owner ball)))\n"
+           "               ball-color))\n"
+           "(define (color ball) (struct-ref (struct-vtable ball) vtable-offset-user))\n"
+           "(define (owner ball) (struct-ref ball 0))\n\n"
+           "(define red (make-ball-type 'red))\n"
+           "(define green (make-ball-type 'green))\n\n"
+           "(define (make-ball type owner) (make-struct type 0 owner))\n\n"
+           "(define ball (make-ball green 'Nisse))\n"
+           "ball @result{} #<a green ball owned by Nisse>\n"
+           "@end lisp")
 #define FUNC_NAME s_scm_make_vtable_vtable
 {
   SCM fields;
   SCM layout;
   int basic_size;
   int tail_elts;
-  SCM * data;
+  scm_t_bits * data;
   SCM handle;
 
-  SCM_VALIDATE_ROSTRING (1,extra_fields);
-  SCM_VALIDATE_INUM (2,tail_array_size);
+  SCM_VALIDATE_STRING (1, user_fields);
+  SCM_VALIDATE_INUM (2, tail_array_size);
+  SCM_VALIDATE_REST_ARGUMENT (init);
 
-  fields = scm_string_append (scm_listify (required_vtable_fields,
-                                          extra_fields,
-                                          SCM_UNDEFINED));
+  fields = scm_string_append (scm_list_2 (required_vtable_fields,
+                                         user_fields));
   layout = scm_make_struct_layout (fields);
-  basic_size = SCM_LENGTH (layout) / 2;
+  basic_size = SCM_SYMBOL_LENGTH (layout) / 2;
   tail_elts = SCM_INUM (tail_array_size);
-  SCM_NEWCELL (handle);
   SCM_DEFER_INTS;
   data = scm_alloc_struct (basic_size + tail_elts,
                           scm_struct_n_extra_words,
-                          "make-vtable-vtable");
-  SCM_SETCDR (handle, data);
-  SCM_SETCAR (handle, ((SCM)data) + scm_tc3_cons_gloc);
-  SCM_STRUCT_LAYOUT (handle) = layout;
-  scm_struct_init (handle, tail_elts, scm_cons (layout, init));
+                          "struct");
+  handle = scm_double_cell ((scm_t_bits) data + scm_tc3_struct,
+                           (scm_t_bits) data, 0, 0);
+  data [scm_vtable_index_layout] = SCM_UNPACK (layout);
+  scm_struct_init (handle, layout, data, tail_elts, scm_cons (layout, init));
   SCM_ALLOW_INTS;
   return handle;
 }
@@ -511,7 +553,7 @@ SCM_DEFINE (scm_make_vtable_vtable, "make-vtable-vtable", 2, 0, 1,
 
 SCM_DEFINE (scm_struct_ref, "struct-ref", 2, 0, 0,
             (SCM handle, SCM pos),
-           "@deffnx primitive struct-set! struct n value\n"
+           "@deffnx {Scheme Procedure} struct-set! struct n value\n"
            "Access (or modify) the @var{n}th field of @var{struct}.\n\n"
            "If the field is of type 'p', then it can be set to an arbitrary value.\n\n"
            "If the field is of type 'u', then it can only be set to a non-negative\n"
@@ -519,29 +561,29 @@ SCM_DEFINE (scm_struct_ref, "struct-ref", 2, 0, 0,
 #define FUNC_NAME s_scm_struct_ref
 {
   SCM answer = SCM_UNDEFINED;
-  SCM * data;
+  scm_t_bits * data;
   SCM layout;
   int p;
-  scm_bits_t n_fields;
-  unsigned char * fields_desc;
-  unsigned char field_type = 0;
+  scm_t_bits n_fields;
+  char * fields_desc;
+  char field_type = 0;
   
 
-  SCM_VALIDATE_STRUCT (1,handle);
-  SCM_VALIDATE_INUM (2,pos);
+  SCM_VALIDATE_STRUCT (1, handle);
+  SCM_VALIDATE_INUM (2, pos);
 
   layout = SCM_STRUCT_LAYOUT (handle);
   data = SCM_STRUCT_DATA (handle);
   p = SCM_INUM (pos);
 
-  fields_desc = (unsigned char *) SCM_CHARS (layout);
-  n_fields = SCM_UNPACK (data[scm_struct_i_n_words]);
+  fields_desc = SCM_SYMBOL_CHARS (layout);
+  n_fields = data[scm_struct_i_n_words];
   
-  SCM_ASSERT_RANGE(1,pos, p < n_fields);
+  SCM_ASSERT_RANGE(1, pos, p < n_fields);
 
-  if (p * 2 < SCM_LENGTH (layout))
+  if (p * 2 < SCM_SYMBOL_LENGTH (layout))
     {
-      unsigned char ref;
+      char ref;
       field_type = fields_desc[p * 2];
       ref = fields_desc[p * 2 + 1];
       if ((ref != 'r') && (ref != 'w'))
@@ -549,21 +591,18 @@ SCM_DEFINE (scm_struct_ref, "struct-ref", 2, 0, 0,
          if ((ref == 'R') || (ref == 'W'))
            field_type = 'u';
          else
-           SCM_ASSERT (0, pos, "ref denied", FUNC_NAME);
+           SCM_MISC_ERROR ("ref denied for field ~A", scm_list_1 (pos));
        }
     }
-  else if (fields_desc[SCM_LENGTH (layout) - 1] != 'O')    
-    field_type = fields_desc[SCM_LENGTH (layout) - 2];
+  else if (fields_desc[SCM_SYMBOL_LENGTH (layout) - 1] != 'O')    
+    field_type = fields_desc[SCM_SYMBOL_LENGTH (layout) - 2];
   else
-    {
-      SCM_ASSERT (0, pos, "ref denied", FUNC_NAME);
-      abort ();
-    }
+    SCM_MISC_ERROR ("ref denied for field ~A", scm_list_1 (pos));
   
   switch (field_type)
     {
     case 'u':
-      answer = scm_ulong2num (SCM_UNPACK (data[p]));
+      answer = scm_ulong2num (data[p]);
       break;
 
 #if 0
@@ -572,19 +611,19 @@ SCM_DEFINE (scm_struct_ref, "struct-ref", 2, 0, 0,
       break;
 
     case 'd':
-      answer = scm_makdbl (*((double *)&(data[p])), 0.0);
+      answer = scm_make_real (*((double *)&(data[p])));
       break;
 #endif
 
     case 's':
     case 'p':
-      answer = data[p];
+      answer = SCM_PACK (data[p]);
       break;
 
 
     default:
-      SCM_ASSERT (0, SCM_MAKE_CHAR (field_type), "unrecognized field type", FUNC_NAME);
-      break;
+      SCM_MISC_ERROR ("unrecognized field type: ~S",
+                     scm_list_1 (SCM_MAKE_CHAR (field_type)));
     }
 
   return answer;
@@ -594,53 +633,52 @@ SCM_DEFINE (scm_struct_ref, "struct-ref", 2, 0, 0,
 
 SCM_DEFINE (scm_struct_set_x, "struct-set!", 3, 0, 0,
             (SCM handle, SCM pos, SCM val),
-           "")
+           "Set the slot of the structure @var{handle} with index @var{pos}\n"
+           "to @var{val}.  Signal an error if the slot can not be written\n"
+           "to.")
 #define FUNC_NAME s_scm_struct_set_x
 {
-  SCM * data;
+  scm_t_bits * data;
   SCM layout;
   int p;
   int n_fields;
-  unsigned char * fields_desc;
-  unsigned char field_type = 0;
+  char * fields_desc;
+  char field_type = 0;
 
-  SCM_VALIDATE_STRUCT (1,handle);
-  SCM_VALIDATE_INUM (2,pos);
+  SCM_VALIDATE_STRUCT (1, handle);
+  SCM_VALIDATE_INUM (2, pos);
 
   layout = SCM_STRUCT_LAYOUT (handle);
   data = SCM_STRUCT_DATA (handle);
   p = SCM_INUM (pos);
 
-  fields_desc = (unsigned char *)SCM_CHARS (layout);
-  n_fields = SCM_UNPACK (data[scm_struct_i_n_words]);
+  fields_desc = SCM_SYMBOL_CHARS (layout);
+  n_fields = data[scm_struct_i_n_words];
 
-  SCM_ASSERT_RANGE (1,pos, p < n_fields);
+  SCM_ASSERT_RANGE (1, pos, p < n_fields);
 
-  if (p * 2 < SCM_LENGTH (layout))
+  if (p * 2 < SCM_SYMBOL_LENGTH (layout))
     {
-      unsigned char set_x;
+      char set_x;
       field_type = fields_desc[p * 2];
       set_x = fields_desc [p * 2 + 1];
       if (set_x != 'w')
-       SCM_ASSERT (0, pos, "set_x denied", FUNC_NAME);
+       SCM_MISC_ERROR ("set! denied for field ~A", scm_list_1 (pos));
     }
-  else if (fields_desc[SCM_LENGTH (layout) - 1] == 'W')    
-    field_type = fields_desc[SCM_LENGTH (layout) - 2];
+  else if (fields_desc[SCM_SYMBOL_LENGTH (layout) - 1] == 'W')    
+    field_type = fields_desc[SCM_SYMBOL_LENGTH (layout) - 2];
   else
-    {
-      SCM_ASSERT (0, pos, "set_x denied", FUNC_NAME);
-      abort ();
-    }
+    SCM_MISC_ERROR ("set! denied for field ~A", scm_list_1 (pos));
   
   switch (field_type)
     {
     case 'u':
-      data[p] = SCM_PACK (SCM_NUM2ULONG (3, val));
+      data[p] = SCM_NUM2ULONG (3, val);
       break;
 
 #if 0
     case 'i':
-      data[p] = SCM_NUM2LONG (3,val);
+      data[p] = SCM_NUM2LONG (3, val);
       break;
 
     case 'd':
@@ -649,16 +687,15 @@ SCM_DEFINE (scm_struct_set_x, "struct-set!", 3, 0, 0,
 #endif
 
     case 'p':
-      data[p] = val;
+      data[p] = SCM_UNPACK (val);
       break;
 
     case 's':
-      SCM_ASSERT (0, SCM_MAKE_CHAR (field_type), "self fields immutable", FUNC_NAME);
-      break;
+      SCM_MISC_ERROR ("self fields immutable", SCM_EOL);
 
     default:
-      SCM_ASSERT (0, SCM_MAKE_CHAR (field_type), "unrecognized field type", FUNC_NAME);
-      break;
+      SCM_MISC_ERROR ("unrecognized field type: ~S",
+                     scm_list_1 (SCM_MAKE_CHAR (field_type)));
     }
 
   return val;
@@ -671,7 +708,7 @@ SCM_DEFINE (scm_struct_vtable, "struct-vtable", 1, 0, 0,
            "Return the vtable structure that describes the type of @var{struct}.")
 #define FUNC_NAME s_scm_struct_vtable
 {
-  SCM_VALIDATE_STRUCT (1,handle);
+  SCM_VALIDATE_STRUCT (1, handle);
   return SCM_STRUCT_VTABLE (handle);
 }
 #undef FUNC_NAME
@@ -679,10 +716,10 @@ SCM_DEFINE (scm_struct_vtable, "struct-vtable", 1, 0, 0,
 
 SCM_DEFINE (scm_struct_vtable_tag, "struct-vtable-tag", 1, 0, 0, 
             (SCM handle),
-           "")
+           "Return the vtable tag of the structure @var{handle}.")
 #define FUNC_NAME s_scm_struct_vtable_tag
 {
-  SCM_VALIDATE_VTABLE (1,handle);
+  SCM_VALIDATE_VTABLE (1, handle);
   return scm_long2num ((long) SCM_STRUCT_DATA (handle) >> 3);
 }
 #undef FUNC_NAME
@@ -694,8 +731,8 @@ SCM_DEFINE (scm_struct_vtable_tag, "struct-vtable-tag", 1, 0, 0,
  * how to associate names with vtables.
  */
 
-unsigned int
-scm_struct_ihashq (SCM obj, unsigned int n)
+unsigned long
+scm_struct_ihashq (SCM obj, unsigned long n)
 {
   /* The length of the hash table should be a relative prime it's not
      necessary to shift down the address.  */
@@ -718,21 +755,21 @@ scm_struct_create_handle (SCM obj)
 
 SCM_DEFINE (scm_struct_vtable_name, "struct-vtable-name", 1, 0, 0, 
             (SCM vtable),
-           "")
+           "Return the name of the vtable @var{vtable}.")
 #define FUNC_NAME s_scm_struct_vtable_name
 {
-  SCM_VALIDATE_VTABLE (1,vtable);
+  SCM_VALIDATE_VTABLE (1, vtable);
   return SCM_STRUCT_TABLE_NAME (SCM_CDR (scm_struct_create_handle (vtable)));
 }
 #undef FUNC_NAME
 
 SCM_DEFINE (scm_set_struct_vtable_name_x, "set-struct-vtable-name!", 2, 0, 0, 
             (SCM vtable, SCM name),
-           "")
+           "Set the name of the vtable @var{vtable} to @var{name}.")
 #define FUNC_NAME s_scm_set_struct_vtable_name_x
 {
-  SCM_VALIDATE_VTABLE (1,vtable);
-  SCM_VALIDATE_SYMBOL (2,name);
+  SCM_VALIDATE_VTABLE (1, vtable);
+  SCM_VALIDATE_SYMBOL (2, name);
   SCM_SET_STRUCT_TABLE_NAME (SCM_CDR (scm_struct_create_handle (vtable)),
                             name);
   return SCM_UNSPECIFIED;
@@ -757,23 +794,37 @@ scm_print_struct (SCM exp, SCM port, scm_print_state *pstate)
       else
        scm_puts ("struct", port);
       scm_putc (' ', port);
-      scm_intprint ((int) vtable, 16, port);
+      scm_intprint (SCM_UNPACK (vtable), 16, port);
       scm_putc (':', port);
-      scm_intprint ((int)exp, 16, port);
+      scm_intprint (SCM_UNPACK (exp), 16, port);
       scm_putc ('>', port);
     }
 }
 
+void
+scm_struct_prehistory ()
+{
+  scm_c_hook_add (&scm_before_mark_c_hook, scm_struct_gc_init, 0, 0);
+  scm_c_hook_add (&scm_after_sweep_c_hook, scm_free_structs, 0, 0);
+}
+
 void
 scm_init_struct ()
 {
   scm_struct_table
     = scm_permanent_object (scm_make_weak_key_hash_table (SCM_MAKINUM (31)));
-  required_vtable_fields = SCM_CAR (scm_intern_obarray ("pruosrpw", sizeof ("pruosrpw") - 1, SCM_BOOL_F));
+  required_vtable_fields = scm_makfrom0str ("prsrpw");
   scm_permanent_object (required_vtable_fields);
-  scm_sysintern ("vtable-index-layout", SCM_MAKINUM (scm_vtable_index_layout));
-  scm_sysintern ("vtable-index-vtable", SCM_MAKINUM (scm_vtable_index_vtable));
-  scm_sysintern ("vtable-index-printer", SCM_MAKINUM (scm_vtable_index_printer));
-  scm_sysintern ("vtable-offset-user", SCM_MAKINUM (scm_vtable_offset_user));
-#include "struct.x"
+  scm_c_define ("vtable-index-layout", SCM_MAKINUM (scm_vtable_index_layout));
+  scm_c_define ("vtable-index-vtable", SCM_MAKINUM (scm_vtable_index_vtable));
+  scm_c_define ("vtable-index-printer",
+               SCM_MAKINUM (scm_vtable_index_printer));
+  scm_c_define ("vtable-offset-user", SCM_MAKINUM (scm_vtable_offset_user));
+#include "libguile/struct.x"
 }
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/