*** empty log message ***
[bpt/guile.git] / libguile / weaks.c
index 144f32c..6e51040 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (C) 1995,1996,1998,2000,2001 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1998,2000,2001, 2003 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 "libguile/_scm.h"
 #include "libguile/vectors.h"
+#include "libguile/lang.h"
+#include "libguile/hashtab.h"
 
 #include "libguile/validate.h"
 #include "libguile/weaks.h"
+
 \f
 
+/* 1. The current hash table implementation in hashtab.c uses weak alist
+ *    vectors (formerly called weak hash tables) internally.
+ *
+ * 2. All hash table operations still work on alist vectors.
+ *
+ * 3. The weak vector and alist vector Scheme API is accessed through
+ *    the module (ice-9 weak-vector).
+ */
+
 
 /* {Weak Vectors}
  */
@@ -63,16 +74,7 @@ SCM_DEFINE (scm_make_weak_vector, "make-weak-vector", 1, 1, 0,
            "empty list.")
 #define FUNC_NAME s_scm_make_weak_vector
 {
-  /* Dirk:FIXME:: We should probably rather use a double cell for weak vectors. */
-  SCM v;
-  v = scm_make_vector (scm_sum (size, SCM_MAKINUM (2)), fill);
-  SCM_DEFER_INTS;
-  SCM_SET_VECTOR_LENGTH (v, SCM_INUM (size), scm_tc7_wvect);
-  SCM_SETVELTS(v, SCM_VELTS(v) + 2);
-  SCM_VELTS(v)[-2] = SCM_EOL;
-  SCM_UNPACK (SCM_VELTS (v)[-1]) = 0;
-  SCM_ALLOW_INTS;
-  return v;
+  return scm_i_allocate_weak_vector (0, size, fill);
 }
 #undef FUNC_NAME
 
@@ -81,30 +83,32 @@ SCM_REGISTER_PROC(s_list_to_weak_vector, "list->weak-vector", 1, 0, 0, scm_weak_
 
 SCM_DEFINE (scm_weak_vector, "weak-vector", 0, 0, 1, 
            (SCM l),
-           "@deffnx primitive list->weak-vector l\n"
+           "@deffnx {Scheme Procedure} list->weak-vector l\n"
            "Construct a weak vector from a list: @code{weak-vector} uses\n"
            "the list of its arguments while @code{list->weak-vector} uses\n"
            "its only argument @var{l} (a list) to construct a weak vector\n"
            "the same way @code{list->vector} would.")
 #define FUNC_NAME s_scm_weak_vector
 {
-  SCM res;
-  SCM *data;
+  scm_t_array_handle handle;
+  SCM res, *data;
   long i;
 
-  /* Dirk:FIXME:: In case of multiple threads, the list might get corrupted
-     while the vector is being created. */
   i = scm_ilength (l);
   SCM_ASSERT (i >= 0, l, SCM_ARG1, FUNC_NAME);
-  res = scm_make_weak_vector (SCM_MAKINUM (i), SCM_UNSPECIFIED);
-  data = SCM_VELTS (res);
 
-  while (!SCM_NULLP (l))
+  res = scm_make_weak_vector (scm_from_int (i), SCM_UNSPECIFIED);
+  data = scm_vector_writable_elements (res, &handle, NULL, NULL);
+
+  while (scm_is_pair (l) && i > 0)
     {
       *data++ = SCM_CAR (l);
       l = SCM_CDR (l);
+      i--;
     }
 
+  scm_array_handle_release (&handle);
+
   return res;
 }
 #undef FUNC_NAME
@@ -116,106 +120,88 @@ SCM_DEFINE (scm_weak_vector_p, "weak-vector?", 1, 0, 0,
            "weak hashes are also weak vectors.")
 #define FUNC_NAME s_scm_weak_vector_p
 {
-  return SCM_BOOL(SCM_WVECTP (obj) && !SCM_IS_WHVEC (obj));
+  return scm_from_bool (SCM_I_WVECTP (obj) && !SCM_IS_WHVEC (obj));
 }
 #undef FUNC_NAME
 
-
-
 \f
 
-
-
-SCM_DEFINE (scm_make_weak_key_hash_table, "make-weak-key-hash-table", 1, 0, 0, 
+SCM_DEFINE (scm_make_weak_key_alist_vector, "make-weak-key-alist-vector", 0, 1, 0, 
            (SCM size),
-           "@deffnx primitive make-weak-value-hash-table size\n"
-           "@deffnx primitive make-doubly-weak-hash-table size\n"
+           "@deffnx {Scheme Procedure} make-weak-value-alist-vector size\n"
+           "@deffnx {Scheme Procedure} make-doubly-weak-alist-vector size\n"
            "Return a weak hash table with @var{size} buckets. As with any\n"
            "hash table, choosing a good size for the table requires some\n"
            "caution.\n"
            "\n"
            "You can modify weak hash tables in exactly the same way you\n"
            "would modify regular hash tables. (@pxref{Hash Tables})")
-#define FUNC_NAME s_scm_make_weak_key_hash_table
+#define FUNC_NAME s_scm_make_weak_key_alist_vector
 {
-  SCM v;
-  SCM_VALIDATE_INUM (1, size);
-  v = scm_make_weak_vector (size, SCM_EOL);
-  SCM_DEFER_INTS;
-  SCM_UNPACK (SCM_VELTS (v)[-1]) = 1;
-  SCM_ALLOW_INTS;
-  return v;
+  return scm_i_allocate_weak_vector
+    (1, SCM_UNBNDP (size) ? scm_from_int (31) : size, SCM_EOL);
 }
 #undef FUNC_NAME
 
 
-SCM_DEFINE (scm_make_weak_value_hash_table, "make-weak-value-hash-table", 1, 0, 0, 
+SCM_DEFINE (scm_make_weak_value_alist_vector, "make-weak-value-alist-vector", 0, 1, 0, 
             (SCM size),
            "Return a hash table with weak values with @var{size} buckets.\n"
            "(@pxref{Hash Tables})")
-#define FUNC_NAME s_scm_make_weak_value_hash_table
+#define FUNC_NAME s_scm_make_weak_value_alist_vector
 {
-  SCM v;
-  SCM_VALIDATE_INUM (1, size);
-  v = scm_make_weak_vector (size, SCM_EOL);
-  SCM_DEFER_INTS;
-  SCM_UNPACK (SCM_VELTS (v)[-1]) = 2;
-  SCM_ALLOW_INTS;
-  return v;
+  return scm_i_allocate_weak_vector
+    (2, SCM_UNBNDP (size) ? scm_from_int (31) : size, SCM_EOL);
 }
 #undef FUNC_NAME
 
 
-
-SCM_DEFINE (scm_make_doubly_weak_hash_table, "make-doubly-weak-hash-table", 1, 0, 0, 
+SCM_DEFINE (scm_make_doubly_weak_alist_vector, "make-doubly-weak-alist-vector", 1, 0, 0, 
             (SCM size),
            "Return a hash table with weak keys and values with @var{size}\n"
            "buckets.  (@pxref{Hash Tables})")
-#define FUNC_NAME s_scm_make_doubly_weak_hash_table
+#define FUNC_NAME s_scm_make_doubly_weak_alist_vector
 {
-  SCM v;
-  SCM_VALIDATE_INUM (1, size);
-  v = scm_make_weak_vector (size, SCM_EOL);
-  SCM_DEFER_INTS;
-  SCM_UNPACK (SCM_VELTS (v)[-1]) = 3;
-  SCM_ALLOW_INTS;
-  return v;
+  return scm_i_allocate_weak_vector
+    (3, SCM_UNBNDP (size) ? scm_from_int (31) : size, SCM_EOL);
 }
 #undef FUNC_NAME
 
-SCM_DEFINE (scm_weak_key_hash_table_p, "weak-key-hash-table?", 1, 0, 0, 
+
+SCM_DEFINE (scm_weak_key_alist_vector_p, "weak-key-alist-vector?", 1, 0, 0, 
            (SCM obj),
-           "@deffnx primitive weak-value-hash-table? obj\n"
-           "@deffnx primitive doubly-weak-hash-table? obj\n"
+           "@deffnx {Scheme Procedure} weak-value-alist-vector? obj\n"
+           "@deffnx {Scheme Procedure} doubly-weak-alist-vector? obj\n"
            "Return @code{#t} if @var{obj} is the specified weak hash\n"
            "table. Note that a doubly weak hash table is neither a weak key\n"
            "nor a weak value hash table.")
-#define FUNC_NAME s_scm_weak_key_hash_table_p
+#define FUNC_NAME s_scm_weak_key_alist_vector_p
 {
-  return SCM_BOOL(SCM_WVECTP (obj) && SCM_IS_WHVEC(obj));
+  return scm_from_bool (SCM_I_WVECTP (obj) && SCM_IS_WHVEC (obj));
 }
 #undef FUNC_NAME
 
 
-SCM_DEFINE (scm_weak_value_hash_table_p, "weak-value-hash-table?", 1, 0, 0, 
+SCM_DEFINE (scm_weak_value_alist_vector_p, "weak-value-alist-vector?", 1, 0, 0, 
             (SCM obj),
            "Return @code{#t} if @var{obj} is a weak value hash table.")
-#define FUNC_NAME s_scm_weak_value_hash_table_p
+#define FUNC_NAME s_scm_weak_value_alist_vector_p
 {
-  return SCM_BOOL(SCM_WVECTP (obj) && SCM_IS_WHVEC_V(obj));
+  return scm_from_bool (SCM_I_WVECTP (obj) && SCM_IS_WHVEC_V (obj));
 }
 #undef FUNC_NAME
 
 
-SCM_DEFINE (scm_doubly_weak_hash_table_p, "doubly-weak-hash-table?", 1, 0, 0, 
+SCM_DEFINE (scm_doubly_weak_alist_vector_p, "doubly-weak-alist-vector?", 1, 0, 0, 
             (SCM obj),
            "Return @code{#t} if @var{obj} is a doubly weak hash table.")
-#define FUNC_NAME s_scm_doubly_weak_hash_table_p
+#define FUNC_NAME s_scm_doubly_weak_alist_vector_p
 {
-  return SCM_BOOL(SCM_WVECTP (obj) && SCM_IS_WHVEC_B (obj));
+  return scm_from_bool (SCM_I_WVECTP (obj) && SCM_IS_WHVEC_B (obj));
 }
 #undef FUNC_NAME
 
+
 static void *
 scm_weak_vector_gc_init (void *dummy1 SCM_UNUSED,
                         void *dummy2 SCM_UNUSED,
@@ -226,6 +212,7 @@ scm_weak_vector_gc_init (void *dummy1 SCM_UNUSED,
   return 0;
 }
 
+
 static void *
 scm_mark_weak_vector_spines (void *dummy1 SCM_UNUSED,
                             void *dummy2 SCM_UNUSED,
@@ -233,29 +220,29 @@ scm_mark_weak_vector_spines (void *dummy1 SCM_UNUSED,
 {
   SCM w;
 
-  for (w = scm_weak_vectors; !SCM_NULLP (w); w = SCM_WVECT_GC_CHAIN (w))
+  for (w = scm_weak_vectors; !scm_is_null (w); w = SCM_I_WVECT_GC_CHAIN (w))
     {
       if (SCM_IS_WHVEC_ANY (w))
        {
-         SCM *ptr;
+         SCM const *ptr;
          SCM obj;
          long j;
          long n;
 
          obj = w;
-         ptr = SCM_VELTS (w);
-         n = SCM_VECTOR_LENGTH (w);
+         ptr = SCM_I_WVECT_GC_WVELTS (w);
+         n = SCM_I_WVECT_LENGTH (w);
          for (j = 0; j < n; ++j)
            {
              SCM alist;
 
              alist = ptr[j];
-             while (   SCM_CONSP (alist)
-                    && !SCM_GCMARKP (alist)
-                    && SCM_CONSP  (SCM_CAR (alist)))
+             while (   scm_is_pair (alist)
+                    && !SCM_GC_MARK_P (alist)
+                    && scm_is_pair  (SCM_CAR (alist)))
                {
-                 SCM_SETGCMARK (alist);
-                 SCM_SETGCMARK (SCM_CAR (alist));
+                 SCM_SET_GC_MARK (alist);
+                 SCM_SET_GC_MARK (SCM_CAR (alist));
                  alist = SCM_CDR (alist);
                }
            }
@@ -265,33 +252,37 @@ scm_mark_weak_vector_spines (void *dummy1 SCM_UNUSED,
   return 0;
 }
 
+#define UNMARKED_CELL_P(x) (SCM_NIMP(x) && !SCM_GC_MARK_P (x))
+
 static void *
 scm_scan_weak_vectors (void *dummy1 SCM_UNUSED,
                       void *dummy2 SCM_UNUSED,
                       void *dummy3 SCM_UNUSED)
 {
   SCM *ptr, w;
-  for (w = scm_weak_vectors; !SCM_NULLP (w); w = SCM_WVECT_GC_CHAIN (w))
+  for (w = scm_weak_vectors; !scm_is_null (w); w = SCM_I_WVECT_GC_CHAIN (w))
     {
       if (!SCM_IS_WHVEC_ANY (w))
        {
          register long j, n;
 
-         ptr = SCM_VELTS (w);
-         n = SCM_VECTOR_LENGTH (w);
+         ptr = SCM_I_WVECT_GC_WVELTS (w);
+         n = SCM_I_WVECT_LENGTH (w);
          for (j = 0; j < n; ++j)
-           if (SCM_FREE_CELL_P (ptr[j]))
+           if (UNMARKED_CELL_P (ptr[j]))
              ptr[j] = SCM_BOOL_F;
        }
-      else /* if (SCM_IS_WHVEC_ANY (scm_weak_vectors[i])) */
+      /* check if we should scan the alist vector here (hashtables
+        have their own scan function in hashtab.c). */
+      else if (!SCM_WVECT_NOSCAN_P (w))
        {
          SCM obj = w;
-         register long n = SCM_VECTOR_LENGTH (w);
+         register long n = SCM_I_WVECT_LENGTH (w);
          register long j;
           int weak_keys = SCM_IS_WHVEC (obj) || SCM_IS_WHVEC_B (obj);
           int weak_values = SCM_IS_WHVEC_V (obj) || SCM_IS_WHVEC_B (obj);
 
-         ptr = SCM_VELTS (w);
+         ptr = SCM_I_WVECT_GC_WVELTS (w);
 
          for (j = 0; j < n; ++j)
            {
@@ -301,16 +292,16 @@ scm_scan_weak_vectors (void *dummy1 SCM_UNUSED,
              fixup = ptr + j;
              alist = *fixup;
 
-             while (   SCM_CONSP (alist)
-                       && SCM_CONSP (SCM_CAR (alist)))
+             while (scm_is_pair (alist)
+                    && scm_is_pair (SCM_CAR (alist)))
                {
                  SCM key;
                  SCM value;
 
                  key = SCM_CAAR (alist);
                  value = SCM_CDAR (alist);
-                 if (   (weak_keys && SCM_FREE_CELL_P (key))
-                        || (weak_values && SCM_FREE_CELL_P (value)))
+                 if (   (weak_keys && UNMARKED_CELL_P (key))
+                        || (weak_values && UNMARKED_CELL_P (value)))
                    {
                      *fixup = SCM_CDR (alist);
                    }
@@ -325,10 +316,8 @@ scm_scan_weak_vectors (void *dummy1 SCM_UNUSED,
   return 0;
 }
 
-
 \f
 
-
 void
 scm_weaks_prehistory ()
 {
@@ -337,12 +326,19 @@ scm_weaks_prehistory ()
   scm_c_hook_add (&scm_after_sweep_c_hook, scm_scan_weak_vectors, 0, 0);
 }
 
+
+SCM
+scm_init_weaks_builtins ()
+{
+#include "libguile/weaks.x"
+  return SCM_UNSPECIFIED;
+}
+
 void
 scm_init_weaks ()
 {
-#ifndef SCM_MAGIC_SNARFER
-#include "libguile/weaks.x"
-#endif
+  scm_c_define_gsubr ("%init-weaks-builtins", 0, 0, 0,
+                     scm_init_weaks_builtins);
 }