guile-backtrace function
[bpt/guile.git] / libguile / alist.c
index da9335f..82c70a0 100644 (file)
@@ -1,78 +1,46 @@
-/* Copyright (C) 1995, 96, 97, 98, 99, 2000 Free Software Foundation, Inc.
+/* Copyright (C) 1995, 96, 97, 98, 99, 2000, 2001, 2004, 2006, 2008, 2010, 2011 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
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 3 of
+ * the License, or (at your option) any later version.
  *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
+ * This library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
- *
- * 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.  */
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
+ */
 
-/* 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>
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
+
 #include "libguile/_scm.h"
 #include "libguile/eq.h"
 #include "libguile/list.h"
 
 #include "libguile/validate.h"
+#include "libguile/pairs.h"
 #include "libguile/alist.h"
 
 \f
 
 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_cons (scm_cons (key, value), alist);
 }
 #undef FUNC_NAME
 
@@ -84,10 +52,10 @@ SCM_DEFINE (scm_sloppy_assq, "sloppy-assq", 2, 0, 0,
            "Recommended only for use in Guile internals.")
 #define FUNC_NAME s_scm_sloppy_assq
 {
-  for (; SCM_CONSP (alist); alist = SCM_CDR (alist))
+  for (; scm_is_pair (alist); alist = SCM_CDR (alist))
     {
       SCM tmp = SCM_CAR (alist);
-      if (SCM_CONSP (tmp) && SCM_EQ_P (SCM_CAR (tmp), key))
+      if (scm_is_pair (tmp) && scm_is_eq (SCM_CAR (tmp), key))
        return tmp;
     }
   return SCM_BOOL_F;
@@ -102,11 +70,11 @@ SCM_DEFINE (scm_sloppy_assv, "sloppy-assv", 2, 0, 0,
            "Recommended only for use in Guile internals.")
 #define FUNC_NAME s_scm_sloppy_assv
 {
-  for (; SCM_CONSP (alist); alist = SCM_CDR (alist))
+  for (; scm_is_pair (alist); alist = SCM_CDR (alist))
     {
       SCM tmp = SCM_CAR (alist);
-      if (SCM_CONSP (tmp)
-         && SCM_NFALSEP (scm_eqv_p (SCM_CAR (tmp), key)))
+      if (scm_is_pair (tmp)
+         && scm_is_true (scm_eqv_p (SCM_CAR (tmp), key)))
        return tmp;
     }
   return SCM_BOOL_F;
@@ -120,11 +88,11 @@ SCM_DEFINE (scm_sloppy_assoc, "sloppy-assoc", 2, 0, 0,
            "Recommended only for use in Guile internals.")
 #define FUNC_NAME s_scm_sloppy_assoc
 {
-  for (; SCM_CONSP (alist); alist = SCM_CDR (alist))
+  for (; scm_is_pair (alist); alist = SCM_CDR (alist))
     {
       SCM tmp = SCM_CAR (alist);
-      if (SCM_CONSP (tmp)
-         && SCM_NFALSEP (scm_equal_p (SCM_CAR (tmp), key)))
+      if (scm_is_pair (tmp)
+         && scm_is_true (scm_equal_p (SCM_CAR (tmp), key)))
        return tmp;
     }
   return SCM_BOOL_F;
@@ -136,25 +104,28 @@ 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
 {
-  for (; SCM_CONSP (alist); alist = SCM_CDR (alist)) 
+  SCM ls = alist;
+  for(; scm_is_pair (ls); ls = SCM_CDR (ls)) 
     {
-      SCM tmp = SCM_CAR (alist);
-      SCM_VALIDATE_CONS (SCM_ARG2, tmp);
-      if (SCM_EQ_P (SCM_CAR (tmp), key))
+      SCM tmp = SCM_CAR (ls);
+      SCM_ASSERT_TYPE (scm_is_pair (tmp), alist, SCM_ARG2, FUNC_NAME,
+                      "association list");
+      if (scm_is_eq (SCM_CAR (tmp), key))
        return tmp;
     }
-  SCM_VALIDATE_NULL (2, alist);
+  SCM_ASSERT_TYPE (SCM_NULL_OR_NIL_P (ls), alist, SCM_ARG2, FUNC_NAME,
+                  "association list");
   return SCM_BOOL_F;
 }
 #undef FUNC_NAME
@@ -165,14 +136,17 @@ SCM_DEFINE (scm_assv, "assv", 2, 0, 0,
            "Behaves like @code{assq} but uses @code{eqv?} for key comparison.")
 #define FUNC_NAME s_scm_assv
 {
-  for(; SCM_CONSP (alist); alist = SCM_CDR (alist)) 
+  SCM ls = alist;
+  for(; scm_is_pair (ls); ls = SCM_CDR (ls)) 
     {
-      SCM tmp = SCM_CAR (alist);
-      SCM_VALIDATE_CONS (SCM_ARG2, tmp);
-      if (SCM_NFALSEP (scm_eqv_p (SCM_CAR (tmp), key)))
+      SCM tmp = SCM_CAR (ls);
+      SCM_ASSERT_TYPE (scm_is_pair (tmp), alist, SCM_ARG2, FUNC_NAME,
+                      "association list");
+      if (scm_is_true (scm_eqv_p (SCM_CAR (tmp), key)))
        return tmp;
     }
-  SCM_VALIDATE_NULL (2, alist);
+  SCM_ASSERT_TYPE (SCM_NULL_OR_NIL_P (ls), alist, SCM_ARG2, FUNC_NAME,
+                  "association list");
   return SCM_BOOL_F;
 }
 #undef FUNC_NAME
@@ -183,14 +157,17 @@ SCM_DEFINE (scm_assoc, "assoc", 2, 0, 0,
            "Behaves like @code{assq} but uses @code{equal?} for key comparison.")
 #define FUNC_NAME s_scm_assoc
 {
-  for(; SCM_CONSP (alist); alist = SCM_CDR (alist)) 
+  SCM ls = alist;
+  for(; scm_is_pair (ls); ls = SCM_CDR (ls)) 
     {
-      SCM tmp = SCM_CAR (alist);
-      SCM_VALIDATE_CONS (SCM_ARG2, tmp);
-      if (SCM_NFALSEP (scm_equal_p (SCM_CAR (tmp), key)))
+      SCM tmp = SCM_CAR (ls);
+      SCM_ASSERT_TYPE (scm_is_pair (tmp), alist, SCM_ARG2, FUNC_NAME,
+                      "association list");
+      if (scm_is_true (scm_equal_p (SCM_CAR (tmp), key)))
        return tmp;
     }
-  SCM_VALIDATE_NULL (2, alist);
+  SCM_ASSERT_TYPE (SCM_NULL_OR_NIL_P (ls), alist, SCM_ARG2, FUNC_NAME,
+                  "association list");
   return SCM_BOOL_F;
 }
 #undef FUNC_NAME
@@ -198,10 +175,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"
@@ -215,7 +204,7 @@ SCM_DEFINE (scm_assq_ref, "assq-ref", 2, 0, 0,
   SCM handle;
 
   handle = scm_sloppy_assq (key, alist);
-  if (SCM_CONSP (handle))
+  if (scm_is_pair (handle))
     {
       return SCM_CDR (handle);
     }
@@ -232,7 +221,7 @@ SCM_DEFINE (scm_assv_ref, "assv-ref", 2, 0, 0,
   SCM handle;
 
   handle = scm_sloppy_assv (key, alist);
-  if (SCM_CONSP (handle))
+  if (scm_is_pair (handle))
     {
       return SCM_CDR (handle);
     }
@@ -249,7 +238,7 @@ SCM_DEFINE (scm_assoc_ref, "assoc-ref", 2, 0, 0,
   SCM handle;
 
   handle = scm_sloppy_assoc (key, alist);
-  if (SCM_CONSP (handle))
+  if (scm_is_pair (handle))
     {
       return SCM_CDR (handle);
     }
@@ -264,11 +253,11 @@ 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"
-           "Reassociate @var{key} in @var{alist} with @var{value}: find any existing\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{val}: 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"
+           "@var{val}.  If @var{alist} does not contain an entry for @var{key},\n"
            "add a new one.  Return the (possibly new) alist.\n\n"
            "These functions do not attempt to verify the structure of @var{alist},\n"
            "and so may cause unusual results if passed an object that is not an\n"
@@ -278,7 +267,7 @@ SCM_DEFINE (scm_assq_set_x, "assq-set!", 3, 0, 0,
   SCM handle;
 
   handle = scm_sloppy_assq (key, alist);
-  if (SCM_CONSP (handle))
+  if (scm_is_pair (handle))
     {
       SCM_SETCDR (handle, val);
       return alist;
@@ -296,7 +285,7 @@ SCM_DEFINE (scm_assv_set_x, "assv-set!", 3, 0, 0,
   SCM handle;
 
   handle = scm_sloppy_assv (key, alist);
-  if (SCM_CONSP (handle))
+  if (scm_is_pair (handle))
     {
       SCM_SETCDR (handle, val);
       return alist;
@@ -314,7 +303,7 @@ SCM_DEFINE (scm_assoc_set_x, "assoc-set!", 3, 0, 0,
   SCM handle;
 
   handle = scm_sloppy_assoc (key, alist);
-  if (SCM_CONSP (handle))
+  if (scm_is_pair (handle))
     {
       SCM_SETCDR (handle, val);
       return alist;
@@ -329,8 +318,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
@@ -338,8 +327,8 @@ SCM_DEFINE (scm_assq_remove_x, "assq-remove!", 2, 0, 0,
   SCM handle;
 
   handle = scm_sloppy_assq (key, alist);
-  if (SCM_CONSP (handle))
-    alist = scm_delq_x (handle, alist);
+  if (scm_is_pair (handle))
+    alist = scm_delq1_x (handle, alist);
 
   return alist;
 }
@@ -354,8 +343,8 @@ SCM_DEFINE (scm_assv_remove_x, "assv-remove!", 2, 0, 0,
   SCM handle;
 
   handle = scm_sloppy_assv (key, alist);
-  if (SCM_CONSP (handle))
-    alist = scm_delq_x (handle, alist);
+  if (scm_is_pair (handle))
+    alist = scm_delq1_x (handle, alist);
 
   return alist;
 }
@@ -370,8 +359,8 @@ SCM_DEFINE (scm_assoc_remove_x, "assoc-remove!", 2, 0, 0,
   SCM handle;
 
   handle = scm_sloppy_assoc (key, alist);
-  if (SCM_CONSP (handle))
-    alist = scm_delq_x (handle, alist);
+  if (scm_is_pair (handle))
+    alist = scm_delq1_x (handle, alist);
 
   return alist;
 }