* Added comments.
[bpt/guile.git] / libguile / hashtab.c
index a40fb00..dd58562 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995,1996 Free Software Foundation, Inc.
+/*     Copyright (C) 1995, 1996, 1998, 1999 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 <stdio.h>
-#include "_scm.h"
-#include "alist.h"
-#include "hash.h"
-#include "eval.h"
-
-#include "hashtab.h"
+#include "libguile/_scm.h"
+#include "libguile/alist.h"
+#include "libguile/hash.h"
+#include "libguile/eval.h"
+#include "libguile/vectors.h"
+
+#include "libguile/validate.h"
+#include "libguile/hashtab.h"
 \f
 
 
 SCM
-scm_hash_fn_get_handle (table, obj, hash_fn, assoc_fn, closure)
-     SCM table;
-     SCM obj;
-     unsigned int (*hash_fn)();
-     SCM (*assoc_fn)();
-     void * closure;
-{
-  int k;
+scm_hash_fn_get_handle (SCM table,SCM obj,unsigned int (*hash_fn)(),SCM (*assoc_fn)(),void * closure)
+{
+  unsigned int k;
   SCM h;
 
-  SCM_ASSERT (SCM_NIMP (table) && SCM_VECTORP (table), table, SCM_ARG1, "hash_fn_get_handle");
+  SCM_ASSERT (SCM_VECTORP (table), table, SCM_ARG1, "hash_fn_get_handle");
   if (SCM_LENGTH (table) == 0)
     return SCM_EOL;
   k = hash_fn (obj, SCM_LENGTH (table), closure);
   SCM_ASSERT ((0 <= k) && (k < SCM_LENGTH (table)),
-             SCM_MAKINUM (k),
+             scm_ulong2num (k),
              SCM_OUTOFRANGE,
              "hash_fn_get_handle");
   h = assoc_fn (obj, SCM_VELTS (table)[k], closure);
@@ -76,23 +77,18 @@ scm_hash_fn_get_handle (table, obj, hash_fn, assoc_fn, closure)
 
 
 SCM
-scm_hash_fn_create_handle_x (table, obj, init, hash_fn, assoc_fn, closure)
-     SCM table;
-     SCM obj;
-     SCM init;
-     unsigned int (*hash_fn)();
-     SCM (*assoc_fn)();
-     void * closure;
-{
-  int k;
+scm_hash_fn_create_handle_x (SCM table,SCM obj,SCM init,unsigned int (*hash_fn)(),
+                             SCM (*assoc_fn)(),void * closure)
+{
+  unsigned int k;
   SCM it;
 
-  SCM_ASSERT (SCM_NIMP (table) && SCM_VECTORP (table), table, SCM_ARG1, "hash_fn_create_handle_x");
+  SCM_ASSERT (SCM_VECTORP (table), table, SCM_ARG1, "hash_fn_create_handle_x");
   if (SCM_LENGTH (table) == 0)
     return SCM_EOL;
   k = hash_fn (obj, SCM_LENGTH (table), closure);
   SCM_ASSERT ((0 <= k) && (k < SCM_LENGTH (table)),
-             SCM_MAKINUM (k),
+             scm_ulong2num (k),
              SCM_OUTOFRANGE,
              "hash_fn_create_handle_x");
   SCM_REDEFER_INTS;
@@ -116,13 +112,8 @@ scm_hash_fn_create_handle_x (table, obj, init, hash_fn, assoc_fn, closure)
 
 
 SCM 
-scm_hash_fn_ref (table, obj, dflt, hash_fn, assoc_fn, closure)
-     SCM table;
-     SCM obj;
-     SCM dflt;
-     unsigned int (*hash_fn)();
-     SCM (*assoc_fn)();
-     void * closure;
+scm_hash_fn_ref (SCM table,SCM obj,SCM dflt,unsigned int (*hash_fn)(),
+                 SCM (*assoc_fn)(),void * closure)
 {
   SCM it;
 
@@ -137,13 +128,8 @@ scm_hash_fn_ref (table, obj, dflt, hash_fn, assoc_fn, closure)
 
 
 SCM 
-scm_hash_fn_set_x (table, obj, val, hash_fn, assoc_fn, closure)
-     SCM table;
-     SCM obj;
-     SCM val;
-     unsigned int (*hash_fn)();
-     SCM (*assoc_fn)();
-     void * closure;
+scm_hash_fn_set_x (SCM table,SCM obj,SCM val,unsigned int (*hash_fn)(),
+                   SCM (*assoc_fn)(),void * closure)
 {
   SCM it;
 
@@ -157,23 +143,18 @@ scm_hash_fn_set_x (table, obj, val, hash_fn, assoc_fn, closure)
 
 
 SCM 
-scm_hash_fn_remove_x (table, obj, hash_fn, assoc_fn, delete_fn, closure)
-     SCM table;
-     SCM obj;
-     unsigned int (*hash_fn)();
-     SCM (*assoc_fn)();
-     SCM (*delete_fn)();
-     void * closure;
-{
-  int k;
+scm_hash_fn_remove_x (SCM table,SCM obj,unsigned int (*hash_fn)(),SCM (*assoc_fn)(),
+                      SCM (*delete_fn)(),void * closure)
+{
+  unsigned int k;
   SCM h;
 
-  SCM_ASSERT (SCM_NIMP (table) && SCM_VECTORP (table), table, SCM_ARG1, "hash_fn_remove_x");
+  SCM_ASSERT (SCM_VECTORP (table), table, SCM_ARG1, "hash_fn_remove_x");
   if (SCM_LENGTH (table) == 0)
     return SCM_EOL;
   k = hash_fn (obj, SCM_LENGTH (table), closure);
   SCM_ASSERT ((0 <= k) && (k < SCM_LENGTH (table)),
-             SCM_MAKINUM (k),
+             scm_ulong2num (k),
              SCM_OUTOFRANGE,
              "hash_fn_remove_x");
   h = assoc_fn (obj, SCM_VELTS (table)[k], closure);
@@ -184,192 +165,204 @@ scm_hash_fn_remove_x (table, obj, hash_fn, assoc_fn, delete_fn, closure)
 
 \f
 
-SCM_PROC (s_hashq_get_handle, "hashq-get-handle", 2, 0, 0, scm_hashq_get_handle);
-
-SCM
-scm_hashq_get_handle (table, obj)
-     SCM table;
-     SCM obj;
+SCM_DEFINE (scm_hashq_get_handle, "hashq-get-handle", 2, 0, 0,
+            (SCM table, SCM obj),
+           "This procedure is similar to its @code{-ref} cousin, but returns a\n"
+           "@dfn{handle} from the hash table rather than the value associated with\n"
+           "@var{key}.  By convention, a handle in a hash table is the pair which\n"
+           "associates a key with a value.  Where @code{hashq-ref table key} returns\n"
+           "only a @code{value}, @code{hashq-get-handle table key} returns the pair\n"
+           "@code{(key . value)}.")
+#define FUNC_NAME s_scm_hashq_get_handle
 {
   return scm_hash_fn_get_handle (table, obj, scm_ihashq, scm_sloppy_assq, 0);
 }
+#undef FUNC_NAME
 
 
-SCM_PROC (s_hashq_create_handle_x, "hashq-create-handle!", 3, 0, 0, scm_hashq_create_handle_x);
-
-SCM
-scm_hashq_create_handle_x (table, obj, init)
-     SCM table;
-     SCM obj;
-     SCM init;
+SCM_DEFINE (scm_hashq_create_handle_x, "hashq-create-handle!", 3, 0, 0,
+            (SCM table, SCM key, SCM init),
+           "This function looks up @var{key} in @var{table} and returns its handle.\n"
+           "If @var{key} is not already present, a new handle is created which\n"
+           "associates @var{key} with @var{init}.")
+#define FUNC_NAME s_scm_hashq_create_handle_x
 {
-  return scm_hash_fn_create_handle_x (table, obj, init, scm_ihashq, scm_sloppy_assq, 0);
+  return scm_hash_fn_create_handle_x (table, key, init, scm_ihashq, scm_sloppy_assq, 0);
 }
+#undef FUNC_NAME
 
 
-SCM_PROC (s_hashq_ref, "hashq-ref", 2, 1, 0, scm_hashq_ref);
-
-SCM 
-scm_hashq_ref (table, obj, dflt)
-     SCM table;
-     SCM obj;
-     SCM dflt;
+SCM_DEFINE (scm_hashq_ref, "hashq-ref", 2, 1, 0,
+            (SCM table, SCM obj, SCM dflt),
+           "Look up @var{key} in the hash table @var{table}, and return the\n"
+           "value (if any) associated with it.  If @var{key} is not found,\n"
+           "return @var{default} (or @code{#f} if no @var{default} argument is\n"
+           "supplied).  Uses `eq?' for equality testing.")
+#define FUNC_NAME s_scm_hashq_ref
 {
-  if (dflt == SCM_UNDEFINED)
+  if (SCM_UNBNDP (dflt))
     dflt = SCM_BOOL_F;
   return scm_hash_fn_ref (table, obj, dflt, scm_ihashq, scm_sloppy_assq, 0);
 }
+#undef FUNC_NAME
 
 
 
-SCM_PROC (s_hashq_set_x, "hashq-set!", 3, 0, 0, scm_hashq_set_x);
-
-SCM 
-scm_hashq_set_x (table, obj, val)
-     SCM table;
-     SCM obj;
-     SCM val;
+SCM_DEFINE (scm_hashq_set_x, "hashq-set!", 3, 0, 0,
+            (SCM table, SCM obj, SCM val),
+           "Find the entry in @var{table} associated with @var{key}, and store\n"
+           "@var{value} there. Uses `eq?' for equality testing.")
+#define FUNC_NAME s_scm_hashq_set_x
 {
   return scm_hash_fn_set_x (table, obj, val, scm_ihashq, scm_sloppy_assq, 0);
 }
+#undef FUNC_NAME
 
 
 
-SCM_PROC (s_hashq_remove_x, "hashq-remove!", 2, 0, 0, scm_hashq_remove_x);
-
-SCM
-scm_hashq_remove_x (table, obj)
-     SCM table;
-     SCM obj;
+SCM_DEFINE (scm_hashq_remove_x, "hashq-remove!", 2, 0, 0,
+            (SCM table, SCM obj),
+           "Remove @var{key} (and any value associated with it) from @var{table}.\n"
+            "Uses `eq?' for equality tests.")
+#define FUNC_NAME s_scm_hashq_remove_x
 {
   return scm_hash_fn_remove_x (table, obj, scm_ihashq, scm_sloppy_assq, scm_delq_x, 0);
 }
+#undef FUNC_NAME
 
 
 \f
 
-SCM_PROC (s_hashv_get_handle, "hashv-get-handle", 2, 0, 0, scm_hashv_get_handle);
-
-SCM
-scm_hashv_get_handle (table, obj)
-     SCM table;
-     SCM obj;
+SCM_DEFINE (scm_hashv_get_handle, "hashv-get-handle", 2, 0, 0,
+            (SCM table, SCM obj),
+           "This procedure is similar to its @code{-ref} cousin, but returns a\n"
+           "@dfn{handle} from the hash table rather than the value associated with\n"
+           "@var{key}.  By convention, a handle in a hash table is the pair which\n"
+           "associates a key with a value.  Where @code{hashv-ref table key} returns\n"
+           "only a @code{value}, @code{hashv-get-handle table key} returns the pair\n"
+           "@code{(key . value)}.")
+#define FUNC_NAME s_scm_hashv_get_handle
 {
   return scm_hash_fn_get_handle (table, obj, scm_ihashv, scm_sloppy_assv, 0);
 }
+#undef FUNC_NAME
 
 
-SCM_PROC (s_hashv_create_handle_x, "hashv-create-handle!", 3, 0, 0, scm_hashv_create_handle_x);
-
-SCM
-scm_hashv_create_handle_x (table, obj, init)
-     SCM table;
-     SCM obj;
-     SCM init;
+SCM_DEFINE (scm_hashv_create_handle_x, "hashv-create-handle!", 3, 0, 0,
+            (SCM table, SCM key, SCM init),
+           "This function looks up @var{key} in @var{table} and returns its handle.\n"
+           "If @var{key} is not already present, a new handle is created which\n"
+           "associates @var{key} with @var{init}.")
+#define FUNC_NAME s_scm_hashv_create_handle_x
 {
-  return scm_hash_fn_create_handle_x (table, obj, init, scm_ihashv, scm_sloppy_assv, 0);
+  return scm_hash_fn_create_handle_x (table, key, init, scm_ihashv, scm_sloppy_assv, 0);
 }
+#undef FUNC_NAME
 
 
-SCM_PROC (s_hashv_ref, "hashv-ref", 2, 1, 0, scm_hashv_ref);
-
-SCM 
-scm_hashv_ref (table, obj, dflt)
-     SCM table;
-     SCM obj;
-     SCM dflt;
+SCM_DEFINE (scm_hashv_ref, "hashv-ref", 2, 1, 0,
+            (SCM table, SCM obj, SCM dflt),
+           "Look up @var{key} in the hash table @var{table}, and return the\n"
+           "value (if any) associated with it.  If @var{key} is not found,\n"
+           "return @var{default} (or @code{#f} if no @var{default} argument is\n"
+           "supplied).  Uses `eqv?' for equality testing.")
+#define FUNC_NAME s_scm_hashv_ref
 {
-  if (dflt == SCM_UNDEFINED)
+  if (SCM_UNBNDP (dflt))
     dflt = SCM_BOOL_F;
   return scm_hash_fn_ref (table, obj, dflt, scm_ihashv, scm_sloppy_assv, 0);
 }
+#undef FUNC_NAME
 
 
 
-SCM_PROC (s_hashv_set_x, "hashv-set!", 3, 0, 0, scm_hashv_set_x);
-
-SCM 
-scm_hashv_set_x (table, obj, val)
-     SCM table;
-     SCM obj;
-     SCM val;
+SCM_DEFINE (scm_hashv_set_x, "hashv-set!", 3, 0, 0,
+            (SCM table, SCM obj, SCM val),
+           "Find the entry in @var{table} associated with @var{key}, and store\n"
+           "@var{value} there. Uses `eqv?' for equality testing.")
+#define FUNC_NAME s_scm_hashv_set_x
 {
   return scm_hash_fn_set_x (table, obj, val, scm_ihashv, scm_sloppy_assv, 0);
 }
+#undef FUNC_NAME
 
 
-SCM_PROC (s_hashv_remove_x, "hashv-remove!", 2, 0, 0, scm_hashv_remove_x);
-
-SCM
-scm_hashv_remove_x (table, obj)
-     SCM table;
-     SCM obj;
+SCM_DEFINE (scm_hashv_remove_x, "hashv-remove!", 2, 0, 0,
+            (SCM table, SCM obj),
+           "Remove @var{key} (and any value associated with it) from @var{table}.\n"
+            "Uses `eqv?' for equality tests.")
+#define FUNC_NAME s_scm_hashv_remove_x
 {
   return scm_hash_fn_remove_x (table, obj, scm_ihashv, scm_sloppy_assv, scm_delv_x, 0);
 }
+#undef FUNC_NAME
 
 \f
 
-SCM_PROC (s_hash_get_handle, "hash-get-handle", 2, 0, 0, scm_hash_get_handle);
-
-SCM
-scm_hash_get_handle (table, obj)
-     SCM table;
-     SCM obj;
+SCM_DEFINE (scm_hash_get_handle, "hash-get-handle", 2, 0, 0,
+            (SCM table, SCM obj),
+           "This procedure is similar to its @code{-ref} cousin, but returns a\n"
+           "@dfn{handle} from the hash table rather than the value associated with\n"
+           "@var{key}.  By convention, a handle in a hash table is the pair which\n"
+           "associates a key with a value.  Where @code{hash-ref table key} returns\n"
+           "only a @code{value}, @code{hash-get-handle table key} returns the pair\n"
+           "@code{(key . value)}.")
+#define FUNC_NAME s_scm_hash_get_handle
 {
   return scm_hash_fn_get_handle (table, obj, scm_ihash, scm_sloppy_assoc, 0);
 }
+#undef FUNC_NAME
 
 
-SCM_PROC (s_hash_create_handle_x, "hash-create-handle!", 3, 0, 0, scm_hash_create_handle_x);
-
-SCM
-scm_hash_create_handle_x (table, obj, init)
-     SCM table;
-     SCM obj;
-     SCM init;
+SCM_DEFINE (scm_hash_create_handle_x, "hash-create-handle!", 3, 0, 0,
+            (SCM table, SCM key, SCM init),
+           "This function looks up @var{key} in @var{table} and returns its handle.\n"
+           "If @var{key} is not already present, a new handle is created which\n"
+           "associates @var{key} with @var{init}.")
+#define FUNC_NAME s_scm_hash_create_handle_x
 {
-  return scm_hash_fn_create_handle_x (table, obj, init, scm_ihash, scm_sloppy_assoc, 0);
+  return scm_hash_fn_create_handle_x (table, key, init, scm_ihash, scm_sloppy_assoc, 0);
 }
+#undef FUNC_NAME
 
 
-SCM_PROC (s_hash_ref, "hash-ref", 2, 1, 0, scm_hash_ref);
-
-SCM 
-scm_hash_ref (table, obj, dflt)
-     SCM table;
-     SCM obj;
-     SCM dflt;
+SCM_DEFINE (scm_hash_ref, "hash-ref", 2, 1, 0,
+            (SCM table, SCM obj, SCM dflt),
+           "Look up @var{key} in the hash table @var{table}, and return the\n"
+           "value (if any) associated with it.  If @var{key} is not found,\n"
+           "return @var{default} (or @code{#f} if no @var{default} argument is\n"
+           "supplied).  Uses `equal?' for equality testing.")
+#define FUNC_NAME s_scm_hash_ref
 {
-  if (dflt == SCM_UNDEFINED)
+  if (SCM_UNBNDP (dflt))
     dflt = SCM_BOOL_F;
   return scm_hash_fn_ref (table, obj, dflt, scm_ihash, scm_sloppy_assoc, 0);
 }
+#undef FUNC_NAME
 
 
 
-SCM_PROC (s_hash_set_x, "hash-set!", 3, 0, 0, scm_hash_set_x);
-
-SCM 
-scm_hash_set_x (table, obj, val)
-     SCM table;
-     SCM obj;
-     SCM val;
+SCM_DEFINE (scm_hash_set_x, "hash-set!", 3, 0, 0,
+            (SCM table, SCM obj, SCM val),
+           "Find the entry in @var{table} associated with @var{key}, and store\n"
+           "@var{value} there. Uses `equal?' for equality testing.")
+#define FUNC_NAME s_scm_hash_set_x
 {
   return scm_hash_fn_set_x (table, obj, val, scm_ihash, scm_sloppy_assoc, 0);
 }
+#undef FUNC_NAME
 
 
 
-SCM_PROC (s_hash_remove_x, "hash-remove!", 2, 0, 0, scm_hash_remove_x);
-
-SCM
-scm_hash_remove_x (table, obj)
-     SCM table;
-     SCM obj;
+SCM_DEFINE (scm_hash_remove_x, "hash-remove!", 2, 0, 0,
+            (SCM table, SCM obj),
+           "Remove @var{key} (and any value associated with it) from @var{table}.\n"
+            "Uses `equal?' for equality tests.")
+#define FUNC_NAME s_scm_hash_remove_x
 {
   return scm_hash_fn_remove_x (table, obj, scm_ihash, scm_sloppy_assoc, scm_delete_x, 0);
 }
+#undef FUNC_NAME
 
 \f
 
@@ -383,144 +376,133 @@ struct scm_ihashx_closure
 
 
 
-static unsigned int scm_ihashx SCM_P ((SCM obj, unsigned int n, struct scm_ihashx_closure * closure));
-
 static unsigned int
-scm_ihashx (obj, n, closure)
-     SCM obj;
-     unsigned int n;
-     struct scm_ihashx_closure * closure;
+scm_ihashx (SCM obj,unsigned int n,struct scm_ihashx_closure * closure)
 {
   SCM answer;
-  SCM_ALLOW_INTS;
+  SCM_DEFER_INTS;
   answer = scm_apply (closure->hash,
                      scm_listify (obj, scm_ulong2num ((unsigned long)n), SCM_UNDEFINED),
                      SCM_EOL);
-  SCM_DEFER_INTS;
+  SCM_ALLOW_INTS;
   return SCM_INUM (answer);
 }
 
 
 
-static SCM scm_sloppy_assx SCM_P ((SCM obj, SCM alist, struct scm_ihashx_closure * closure));
-
 static SCM
-scm_sloppy_assx (obj, alist, closure)
-     SCM obj;
-     SCM alist;
-     struct scm_ihashx_closure * closure;
+scm_sloppy_assx (SCM obj,SCM alist,struct scm_ihashx_closure * closure)
 {
   SCM answer;
-  SCM_ALLOW_INTS;
+  SCM_DEFER_INTS;
   answer = scm_apply (closure->assoc,
                      scm_listify (obj, alist, SCM_UNDEFINED),
                      SCM_EOL);
-  SCM_DEFER_INTS;
+  SCM_ALLOW_INTS;
   return answer;
 }
 
 
 
 
-static SCM scm_delx_x SCM_P ((SCM obj, SCM alist, struct scm_ihashx_closure * closure));
-
 static SCM
-scm_delx_x (obj, alist, closure)
-     SCM obj;
-     SCM alist;
-     struct scm_ihashx_closure * closure;
+scm_delx_x (SCM obj,SCM alist,struct scm_ihashx_closure * closure)
 {
   SCM answer;
-  SCM_ALLOW_INTS;
+  SCM_DEFER_INTS;
   answer = scm_apply (closure->delete,
                      scm_listify (obj, alist, SCM_UNDEFINED),
                      SCM_EOL);
-  SCM_DEFER_INTS;
+  SCM_ALLOW_INTS;
   return answer;
 }
 
 
 
-SCM_PROC (s_hashx_get_handle, "hashx-get-handle", 4, 0, 0, scm_hashx_get_handle);
-
-SCM
-scm_hashx_get_handle (hash, assoc, table, obj)
-     SCM hash;
-     SCM assoc;
-     SCM table;
-     SCM obj;
+SCM_DEFINE (scm_hashx_get_handle, "hashx-get-handle", 4, 0, 0, 
+            (SCM hash, SCM assoc, SCM table, SCM obj),
+           "This behaves the same way as the corresponding @code{-get-handle}\n"
+           "function, but uses @var{hasher} as a\n"
+           "hash function and @var{assoc} to compare keys.  @code{hasher} must\n"
+           "be a function that takes two arguments, a key to be hashed and a\n"
+           "table size.  @code{assoc} must be an associator function, like\n"
+           "@code{assoc}, @code{assq} or @code{assv}.")
+#define FUNC_NAME s_scm_hashx_get_handle
 {
   struct scm_ihashx_closure closure;
   closure.hash = hash;
   closure.assoc = assoc;
   return scm_hash_fn_get_handle (table, obj, scm_ihashx, scm_sloppy_assx, (void *)&closure);
 }
-
-
-SCM_PROC (s_hashx_create_handle_x, "hashx-create-handle!", 5, 0, 0, scm_hashx_create_handle_x);
-
-SCM
-scm_hashx_create_handle_x (hash, assoc, table, obj, init)
-     SCM hash;
-     SCM assoc;
-     SCM table;
-     SCM obj;
-     SCM init;
+#undef FUNC_NAME
+
+
+SCM_DEFINE (scm_hashx_create_handle_x, "hashx-create-handle!", 5, 0, 0, 
+            (SCM hash,SCM assoc,SCM table,SCM obj,SCM init),
+           "This behaves the same way as the corresponding @code{-create-handle}\n"
+           "function, but uses @var{hasher} as a\n"
+           "hash function and @var{assoc} to compare keys.  @code{hasher} must\n"
+           "be a function that takes two arguments, a key to be hashed and a\n"
+           "table size.  @code{assoc} must be an associator function, like\n"
+           "@code{assoc}, @code{assq} or @code{assv}.")
+#define FUNC_NAME s_scm_hashx_create_handle_x
 {
   struct scm_ihashx_closure closure;
   closure.hash = hash;
   closure.assoc = assoc;
   return scm_hash_fn_create_handle_x (table, obj, init, scm_ihashx, scm_sloppy_assx, (void *)&closure);
 }
+#undef FUNC_NAME
 
 
 
-SCM_PROC (s_hashx_ref, "hashx-ref", 4, 1, 0, scm_hashx_ref);
-
-SCM 
-scm_hashx_ref (hash, assoc, table, obj, dflt)
-     SCM hash;
-     SCM assoc;
-     SCM table;
-     SCM obj;
-     SCM dflt;
+SCM_DEFINE (scm_hashx_ref, "hashx-ref", 4, 1, 0, 
+            (SCM hash,SCM assoc,SCM table,SCM obj,SCM dflt),
+           "This behaves the same way as the corresponding @code{ref}\n"
+           "function, but uses @var{hasher} as a\n"
+           "hash function and @var{assoc} to compare keys.  @code{hasher} must\n"
+           "be a function that takes two arguments, a key to be hashed and a\n"
+           "table size.  @code{assoc} must be an associator function, like\n"
+           "@code{assoc}, @code{assq} or @code{assv}.\n\n"
+           "By way of illustration, @code{hashq-ref table key} is equivalent\n"
+           "to @code{hashx-ref hashq assq table key}.")
+#define FUNC_NAME s_scm_hashx_ref
 {
   struct scm_ihashx_closure closure;
-  if (dflt == SCM_UNDEFINED)
+  if (SCM_UNBNDP (dflt))
     dflt = SCM_BOOL_F;
   closure.hash = hash;
   closure.assoc = assoc;
   return scm_hash_fn_ref (table, obj, dflt, scm_ihashx, scm_sloppy_assx, (void *)&closure);
 }
+#undef FUNC_NAME
 
 
 
 
-SCM_PROC (s_hashx_set_x, "hashx-set!", 5, 0, 0, scm_hashx_set_x);
-
-SCM 
-scm_hashx_set_x (hash, assoc, table, obj, val)
-     SCM hash;
-     SCM assoc;
-     SCM table;
-     SCM obj;
-     SCM val;
+SCM_DEFINE (scm_hashx_set_x, "hashx-set!", 5, 0, 0,
+            (SCM hash, SCM assoc, SCM table, SCM obj, SCM val),
+           "This behaves the same way as the corresponding @code{set!}\n"
+           "function, but uses @var{hasher} as a\n"
+           "hash function and @var{assoc} to compare keys.  @code{hasher} must\n"
+           "be a function that takes two arguments, a key to be hashed and a\n"
+           "table size.  @code{assoc} must be an associator function, like\n"
+           "@code{assoc}, @code{assq} or @code{assv}.\n\n"
+           "By way of illustration, @code{hashq-set! table key} is equivalent\n"
+           "to @code{hashx-set! hashq assq table key}.")
+#define FUNC_NAME s_scm_hashx_set_x
 {
   struct scm_ihashx_closure closure;
   closure.hash = hash;
   closure.assoc = assoc;
   return scm_hash_fn_set_x (table, obj, val, scm_ihashx, scm_sloppy_assx, (void *)&closure);
 }
+#undef FUNC_NAME
 
 
 
 SCM
-scm_hashx_remove_x (hash, assoc, delete, table, obj)
-     SCM hash;
-     SCM assoc;
-     SCM delete;
-     SCM table;
-     SCM obj;
+scm_hashx_remove_x (SCM hash,SCM assoc,SCM delete,SCM table,SCM obj)
 {
   struct scm_ihashx_closure closure;
   closure.hash = hash;
@@ -529,12 +511,63 @@ scm_hashx_remove_x (hash, assoc, delete, table, obj)
   return scm_hash_fn_remove_x (table, obj, scm_ihashx, scm_sloppy_assx, scm_delx_x, 0);
 }
 
+static SCM
+fold_proc (void *proc, SCM key, SCM data, SCM value)
+{
+  return scm_apply (SCM_PACK (proc), SCM_LIST3 (key, data, value), SCM_EOL);
+}
+
+SCM_DEFINE (scm_hash_fold, "hash-fold", 3, 0, 0, 
+            (SCM proc, SCM init, SCM table),
+           "An iterator over hash-table elements.\n"
+            "Accumulates and returns a result by applying PROC successively.\n"
+            "The arguments to PROC are \"(key value prior-result)\" where key\n"
+            "and value are successive pairs from the hash table TABLE, and\n"
+            "prior-result is either INIT (for the first application of PROC)\n"
+            "or the return value of the previous application of PROC.\n"
+            "For example, @code{(hash-fold acons () tab)} will convert a hash\n"
+            "table into an a-list of key-value pairs.\n")
+#define FUNC_NAME s_scm_hash_fold
+{
+  SCM_VALIDATE_PROC (1,proc);
+  SCM_VALIDATE_VECTOR (3,table);
+  return scm_internal_hash_fold (fold_proc, (void *) SCM_UNPACK (proc), init, table);
+}
+#undef FUNC_NAME
+
+SCM
+scm_internal_hash_fold (SCM (*fn) (), void *closure, SCM init, SCM table)
+{
+  int i, n = SCM_LENGTH (table);
+  SCM result = init;
+  for (i = 0; i < n; ++i)
+    {
+      SCM ls = SCM_VELTS (table)[i], handle;
+      while (SCM_NNULLP (ls))
+       {
+         SCM_ASSERT (SCM_CONSP (ls),
+                     table, SCM_ARG1, s_scm_hash_fold);
+         handle = SCM_CAR (ls);
+         SCM_ASSERT (SCM_CONSP (handle),
+                     table, SCM_ARG1, s_scm_hash_fold);
+         result = fn (closure, SCM_CAR (handle), SCM_CDR (handle), result);
+         ls = SCM_CDR (ls);
+       }
+    }
+  return result;
+}
+
 \f
 
 
 void
 scm_init_hashtab ()
 {
-#include "hashtab.x"
+#include "libguile/hashtab.x"
 }
 
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/