Changes in doc/ref:
[bpt/guile.git] / libguile / alist.c
index 7e1414e..07bd643 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (C) 1995, 96, 97, 98, 99, 2000 Free Software Foundation, Inc.
+/* Copyright (C) 1995, 96, 97, 98, 99, 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 "libguile/_scm.h"
 #include "libguile/eq.h"
 #include "libguile/list.h"
+#include "libguile/lang.h"
 
 #include "libguile/validate.h"
 #include "libguile/alist.h"
 
 SCM_DEFINE (scm_acons, "acons", 3, 0, 0,
            (SCM key, SCM value, SCM alist),
-           "Adds a new key-value pair to @var{alist}.  A new pair is\n"
+           "Add a new key-value pair to @var{alist}.  A new pair is\n"
            "created whose car is @var{key} and whose cdr is @var{value}, and the\n"
            "pair is consed onto @var{alist}, and the new list is returned.  This\n"
            "function is @emph{not} destructive; @var{alist} is not modified.")
 #define FUNC_NAME s_scm_acons
 {
-  SCM pair;
-  SCM head;
-
-  SCM_NEWCELL (pair);
-  SCM_SET_CELL_OBJECT_0 (pair, key);
-  SCM_SET_CELL_OBJECT_1 (pair, value);
-
-  SCM_NEWCELL (head);
-  SCM_SET_CELL_OBJECT_0 (head, pair);
-  SCM_SET_CELL_OBJECT_1 (head, alist);
-
-  return head;
+  return scm_cell (SCM_UNPACK (scm_cell (SCM_UNPACK (key),
+                                        SCM_UNPACK (value))),
+                  SCM_UNPACK (alist));
 }
 #undef FUNC_NAME
 
@@ -136,14 +125,14 @@ SCM_DEFINE (scm_sloppy_assoc, "sloppy-assoc", 2, 0, 0,
 
 SCM_DEFINE (scm_assq, "assq", 2, 0, 0,
            (SCM key, SCM alist),
-           "@deffnx primitive assv key alist\n"
-           "@deffnx primitive assoc key alist\n"
-           "Fetches the entry in @var{alist} that is associated with @var{key}.  To\n"
+           "@deffnx {Scheme Procedure} assv key alist\n"
+           "@deffnx {Scheme Procedure} assoc key alist\n"
+           "Fetch the entry in @var{alist} that is associated with @var{key}.  To\n"
            "decide whether the argument @var{key} matches a particular entry in\n"
            "@var{alist}, @code{assq} compares keys with @code{eq?}, @code{assv}\n"
            "uses @code{eqv?} and @code{assoc} uses @code{equal?}.  If @var{key}\n"
            "cannot be found in @var{alist} (according to whichever equality\n"
-           "predicate is in use), then @code{#f} is returned.  These functions\n"
+           "predicate is in use), then return @code{#f}.  These functions\n"
            "return the entire alist entry found (i.e. both the key and the value).")
 #define FUNC_NAME s_scm_assq
 {
@@ -156,7 +145,7 @@ SCM_DEFINE (scm_assq, "assq", 2, 0, 0,
       if (SCM_EQ_P (SCM_CAR (tmp), key))
        return tmp;
     }
-  SCM_ASSERT_TYPE (SCM_NULLP (ls), alist, SCM_ARG2, FUNC_NAME,
+  SCM_ASSERT_TYPE (SCM_NULL_OR_NIL_P (ls), alist, SCM_ARG2, FUNC_NAME,
                   "association list");
   return SCM_BOOL_F;
 }
@@ -177,7 +166,7 @@ SCM_DEFINE (scm_assv, "assv", 2, 0, 0,
       if (SCM_NFALSEP (scm_eqv_p (SCM_CAR (tmp), key)))
        return tmp;
     }
-  SCM_ASSERT_TYPE (SCM_NULLP (ls), alist, SCM_ARG2, FUNC_NAME,
+  SCM_ASSERT_TYPE (SCM_NULL_OR_NIL_P (ls), alist, SCM_ARG2, FUNC_NAME,
                   "association list");
   return SCM_BOOL_F;
 }
@@ -198,7 +187,7 @@ SCM_DEFINE (scm_assoc, "assoc", 2, 0, 0,
       if (SCM_NFALSEP (scm_equal_p (SCM_CAR (tmp), key)))
        return tmp;
     }
-  SCM_ASSERT_TYPE (SCM_NULLP (ls), alist, SCM_ARG2, FUNC_NAME,
+  SCM_ASSERT_TYPE (SCM_NULL_OR_NIL_P (ls), alist, SCM_ARG2, FUNC_NAME,
                   "association list");
   return SCM_BOOL_F;
 }
@@ -207,10 +196,22 @@ SCM_DEFINE (scm_assoc, "assoc", 2, 0, 0,
 
 \f
 
+/* Dirk:API2.0:: We should not return #f if the key was not found.  In the
+ * current solution we can not distinguish between finding a (key . #f) pair
+ * and not finding the key at all.
+ *
+ * Possible alternative solutions:
+ * 1) Remove assq-ref from the API:  assq is sufficient.
+ * 2) Signal an error (what error type?) if the key is not found.
+ * 3) provide an additional 'default' parameter.
+ * 3.1) The default parameter is mandatory.
+ * 3.2) The default parameter is optional, but if no default is given and
+ *      the key is not found, signal an error (what error type?).
+ */
 SCM_DEFINE (scm_assq_ref, "assq-ref", 2, 0, 0,
             (SCM alist, SCM key),
-           "@deffnx primitive assv-ref alist key\n"
-           "@deffnx primitive assoc-ref alist key\n"
+           "@deffnx {Scheme Procedure} assv-ref alist key\n"
+           "@deffnx {Scheme Procedure} assoc-ref alist key\n"
            "Like @code{assq}, @code{assv} and @code{assoc}, except that only the\n"
            "value associated with @var{key} in @var{alist} is returned.  These\n"
            "functions are equivalent to\n\n"
@@ -273,8 +274,8 @@ SCM_DEFINE (scm_assoc_ref, "assoc-ref", 2, 0, 0,
 
 SCM_DEFINE (scm_assq_set_x, "assq-set!", 3, 0, 0,
             (SCM alist, SCM key, SCM val),
-           "@deffnx primitive assv-set! alist key value\n"
-           "@deffnx primitive assoc-set! alist key value\n"
+           "@deffnx {Scheme Procedure} assv-set! alist key value\n"
+           "@deffnx {Scheme Procedure} assoc-set! alist key value\n"
            "Reassociate @var{key} in @var{alist} with @var{value}: find any existing\n"
            "@var{alist} entry for @var{key} and associate it with the new\n"
            "@var{value}.  If @var{alist} does not contain an entry for @var{key},\n"
@@ -338,8 +339,8 @@ SCM_DEFINE (scm_assoc_set_x, "assoc-set!", 3, 0, 0,
 
 SCM_DEFINE (scm_assq_remove_x, "assq-remove!", 2, 0, 0,
             (SCM alist, SCM key),
-           "@deffnx primitive assv-remove! alist key\n"
-           "@deffnx primitive assoc-remove! alist key\n"
+           "@deffnx {Scheme Procedure} assv-remove! alist key\n"
+           "@deffnx {Scheme Procedure} assoc-remove! alist key\n"
            "Delete the first entry in @var{alist} associated with @var{key}, and return\n"
            "the resulting alist.")
 #define FUNC_NAME s_scm_assq_remove_x
@@ -394,7 +395,9 @@ SCM_DEFINE (scm_assoc_remove_x, "assoc-remove!", 2, 0, 0,
 void
 scm_init_alist ()
 {
+#ifndef SCM_MAGIC_SNARFER
 #include "libguile/alist.x"
+#endif
 }