*** empty log message ***
[bpt/guile.git] / libguile / weaks.c
index 91167d2..a39b587 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995,1996,1998, 2000 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}
  */
 
 
+/* Allocate memory for a weak vector on behalf of the caller.  The allocated
+ * vector will be of the given weak vector subtype.  It will contain size
+ * elements which are initialized with the 'fill' object, or, if 'fill' is
+ * undefined, with an unspecified object.
+ */
+SCM
+scm_i_allocate_weak_vector (scm_t_bits type, SCM size, SCM fill, const char* caller)
+#define FUNC_NAME caller
+{
+  if (SCM_INUMP (size))
+    {
+      size_t c_size;
+      SCM v;
+
+      SCM_ASSERT_RANGE (1, size, SCM_INUM (size) >= 0);
+      c_size = SCM_INUM (size);
+
+      if (c_size > 0)
+       {
+         scm_t_bits *base;
+         size_t j;
+
+         if (SCM_UNBNDP (fill))
+           fill = SCM_UNSPECIFIED;
+
+         SCM_ASSERT_RANGE (1, size, c_size <= SCM_VECTOR_MAX_LENGTH);
+         base = scm_gc_malloc (c_size * sizeof (scm_t_bits), "weak vector");
+         for (j = 0; j != c_size; ++j)
+           base[j] = SCM_UNPACK (fill);
+         v = scm_double_cell (SCM_MAKE_VECTOR_TAG (c_size, scm_tc7_wvect),
+                              (scm_t_bits) base,
+                              type,
+                              SCM_UNPACK (SCM_EOL));
+         scm_remember_upto_here_1 (fill);
+       }
+      else
+       {
+         v = scm_double_cell (SCM_MAKE_VECTOR_TAG (0, scm_tc7_wvect),
+                              (scm_t_bits) NULL,
+                              type,
+                              SCM_UNPACK (SCM_EOL));
+       }
+
+      return v;
+    }
+  else if (SCM_BIGP (size))
+    SCM_OUT_OF_RANGE (1, size);
+  else
+    SCM_WRONG_TYPE_ARG (1, size);
+}
+#undef FUNC_NAME
+
 SCM_DEFINE (scm_make_weak_vector, "make-weak-vector", 1, 1, 0,
-           (SCM k, SCM fill),
+           (SCM size, SCM fill),
            "Return a weak vector with @var{size} elements. If the optional\n"
-           "argument @var{fill} is given, all entries in the vector will be set to\n"
-           "@var{fill}. The default value for @var{fill} is the empty list.")
+           "argument @var{fill} is given, all entries in the vector will be\n"
+           "set to @var{fill}. The default value for @var{fill} is the\n"
+           "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 (k, SCM_MAKINUM (2)), fill);
-  SCM_DEFER_INTS;
-  SCM_SET_VECTOR_LENGTH (v, SCM_INUM (k), 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, FUNC_NAME);
 }
 #undef FUNC_NAME
 
@@ -80,144 +135,141 @@ 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"
-           "Construct a weak vector from a list: @code{weak-vector} uses the list of\n"
-           "its arguments while @code{list->weak-vector} uses its only argument\n"
-           "@var{l} (a list) to construct a weak vector the same way\n"
-           "@code{vector->list} would.")
+           "@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;
-  register SCM *data;
+  SCM *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);
-  for (;
-       i && SCM_CONSP (l);
-       --i, l = SCM_CDR (l))
-    *data++ = SCM_CAR (l);
+
+  /*
+    no alloc, so  this loop is safe.
+  */     
+  data = SCM_WRITABLE_VELTS (res);
+  while (!SCM_NULL_OR_NIL_P (l))
+    {
+      *data++ = SCM_CAR (l);
+      l = SCM_CDR (l);
+    }
+
   return res;
 }
 #undef FUNC_NAME
 
 
 SCM_DEFINE (scm_weak_vector_p, "weak-vector?", 1, 0, 0, 
-           (SCM x),
-           "Return @var{#t} if @var{obj} is a weak vector. Note that all weak\n"
-           "hashes are also weak vectors.")
+           (SCM obj),
+           "Return @code{#t} if @var{obj} is a weak vector. Note that all\n"
+           "weak hashes are also weak vectors.")
 #define FUNC_NAME s_scm_weak_vector_p
 {
-  return SCM_BOOL(SCM_WVECTP (x) && !SCM_IS_WHVEC (x));
+  return SCM_BOOL (SCM_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 k),
-           "@deffnx primitive make-weak-value-hash-table size\n"
-           "@deffnx primitive make-doubly-weak-hash-table size\n"
-           "Return a weak hash table with @var{size} buckets. As with any hash\n"
-           "table, choosing a good size for the table requires some caution.\n\n"
-           "You can modify weak hash tables in exactly the same way you would modify\n"
-           "regular hash tables. (@pxref{Hash Tables})")
-#define FUNC_NAME s_scm_make_weak_key_hash_table
+SCM_DEFINE (scm_make_weak_key_alist_vector, "make-weak-key-alist-vector", 0, 1, 0, 
+           (SCM size),
+           "@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_alist_vector
 {
-  SCM v;
-  SCM_VALIDATE_INUM (1,k);
-  v = scm_make_weak_vector (k, 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_MAKINUM (31) : size, SCM_EOL, FUNC_NAME);
 }
 #undef FUNC_NAME
 
 
-SCM_DEFINE (scm_make_weak_value_hash_table, "make-weak-value-hash-table", 1, 0, 0, 
-            (SCM k),
+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,k);
-  v = scm_make_weak_vector (k, 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_MAKINUM (31) : size, SCM_EOL, FUNC_NAME);
 }
 #undef FUNC_NAME
 
 
-
-SCM_DEFINE (scm_make_doubly_weak_hash_table, "make-doubly-weak-hash-table", 1, 0, 0, 
-            (SCM k),
+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,k);
-  v = scm_make_weak_vector (k, 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_MAKINUM (31) : size, SCM_EOL, FUNC_NAME);
 }
 #undef FUNC_NAME
 
-SCM_DEFINE (scm_weak_key_hash_table_p, "weak-key-hash-table?", 1, 0, 0, 
-           (SCM x),
-           "@deffnx primitive weak-value-hash-table? obj\n"
-           "@deffnx primitive doubly-weak-hash-table? obj\n"
-           "Return @var{#t} if @var{obj} is the specified weak hash table. Note\n"
-           "that a doubly weak hash table is neither a weak key nor a weak value\n"
-           "hash table.")
-#define FUNC_NAME s_scm_weak_key_hash_table_p
+
+SCM_DEFINE (scm_weak_key_alist_vector_p, "weak-key-alist-vector?", 1, 0, 0, 
+           (SCM obj),
+           "@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_alist_vector_p
 {
-  return SCM_BOOL(SCM_WVECTP (x) && SCM_IS_WHVEC(x));
+  return SCM_BOOL (SCM_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 x),
-           "Return @var{#t} if @var{x} is a weak value hash table.")
-#define FUNC_NAME s_scm_weak_value_hash_table_p
+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_alist_vector_p
 {
-  return SCM_BOOL(SCM_WVECTP (x) && SCM_IS_WHVEC_V(x));
+  return SCM_BOOL (SCM_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 x),
-           "Return @var{#t} if @var{x} is a doubly weak hash table.")
-#define FUNC_NAME s_scm_doubly_weak_hash_table_p
+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_alist_vector_p
 {
-  return SCM_BOOL(SCM_WVECTP (x) && SCM_IS_WHVEC_B (x));
+  return SCM_BOOL (SCM_WVECTP (obj) && SCM_IS_WHVEC_B (obj));
 }
 #undef FUNC_NAME
 
+
 static void *
-scm_weak_vector_gc_init (void *dummy1, void *dummy2, void *dummy3)
+scm_weak_vector_gc_init (void *dummy1 SCM_UNUSED,
+                        void *dummy2 SCM_UNUSED,
+                        void *dummy3 SCM_UNUSED)
 {
   scm_weak_vectors = SCM_EOL;
 
   return 0;
 }
 
+
 static void *
-scm_mark_weak_vector_spines (void *dummy1, void *dummy2, void *dummy3)
+scm_mark_weak_vector_spines (void *dummy1 SCM_UNUSED,
+                            void *dummy2 SCM_UNUSED,
+                            void *dummy3 SCM_UNUSED)
 {
   SCM w;
 
@@ -225,10 +277,10 @@ scm_mark_weak_vector_spines (void *dummy1, void *dummy2, void *dummy3)
     {
       if (SCM_IS_WHVEC_ANY (w))
        {
-         SCM *ptr;
+         SCM const *ptr;
          SCM obj;
-         int j;
-         int n;
+         long j;
+         long n;
 
          obj = w;
          ptr = SCM_VELTS (w);
@@ -239,11 +291,11 @@ scm_mark_weak_vector_spines (void *dummy1, void *dummy2, void *dummy3)
 
              alist = ptr[j];
              while (   SCM_CONSP (alist)
-                    && !SCM_GCMARKP (alist)
+                    && !SCM_GC_MARK_P (alist)
                     && SCM_CONSP  (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);
                }
            }
@@ -253,8 +305,12 @@ scm_mark_weak_vector_spines (void *dummy1, void *dummy2, void *dummy3)
   return 0;
 }
 
+#define UNMARKED_CELL_P(x) (SCM_NIMP(x) && !SCM_GC_MARK_P (x))
+
 static void *
-scm_scan_weak_vectors (void *dummy1, void *dummy2, void *dummy3)
+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))
@@ -263,13 +319,15 @@ scm_scan_weak_vectors (void *dummy1, void *dummy2, void *dummy3)
        {
          register long j, n;
 
-         ptr = SCM_VELTS (w);
+         ptr = SCM_GC_WRITABLE_VELTS (w);
          n = SCM_VECTOR_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);
@@ -277,7 +335,7 @@ scm_scan_weak_vectors (void *dummy1, void *dummy2, void *dummy3)
           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_GC_WRITABLE_VELTS (w);
 
          for (j = 0; j < n; ++j)
            {
@@ -287,16 +345,16 @@ scm_scan_weak_vectors (void *dummy1, void *dummy2, void *dummy3)
              fixup = ptr + j;
              alist = *fixup;
 
-             while (   SCM_CONSP (alist)
-                       && SCM_CONSP (SCM_CAR (alist)))
+             while (SCM_CONSP (alist)
+                    && SCM_CONSP (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);
                    }
@@ -311,10 +369,8 @@ scm_scan_weak_vectors (void *dummy1, void *dummy2, void *dummy3)
   return 0;
 }
 
-
 \f
 
-
 void
 scm_weaks_prehistory ()
 {
@@ -323,12 +379,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);
 }