-/* Copyright (C) 1995, 1996, 1998 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
* 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. */
-\f
-#include <stdio.h>
-#include "_scm.h"
-#include "eq.h"
-#include "list.h"
-#include "alist.h"
\f
+#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_PROC(s_acons, "acons", 3, 0, 0, scm_acons);
+\f
-SCM
-scm_acons (w, x, y)
- SCM w;
- SCM x;
- SCM y;
+SCM_DEFINE (scm_acons, "acons", 3, 0, 0,
+ (SCM key, SCM value, SCM alist),
+ "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
{
- register SCM z;
- SCM_NEWCELL (z);
- SCM_SETCAR (z, w);
- SCM_SETCDR (z, x);
- x = z;
- SCM_NEWCELL (z);
- SCM_SETCAR (z, x);
- SCM_SETCDR (z, y);
- return z;
+ return scm_cell (SCM_UNPACK (scm_cell (SCM_UNPACK (key),
+ SCM_UNPACK (value))),
+ SCM_UNPACK (alist));
}
+#undef FUNC_NAME
\f
-SCM_PROC (s_sloppy_assq, "sloppy-assq", 2, 0, 0, scm_sloppy_assq);
-
-SCM
-scm_sloppy_assq(x, alist)
- SCM x;
- SCM alist;
+SCM_DEFINE (scm_sloppy_assq, "sloppy-assq", 2, 0, 0,
+ (SCM key, SCM alist),
+ "Behaves like @code{assq} but does not do any error checking.\n"
+ "Recommended only for use in Guile internals.")
+#define FUNC_NAME s_scm_sloppy_assq
{
-
- for (; SCM_NIMP (alist) && SCM_CONSP (alist); alist = SCM_CDR (alist))
+ for (; SCM_CONSP (alist); alist = SCM_CDR (alist))
{
- SCM tmp = SCM_CAR(alist);
- if (SCM_NIMP (tmp) && SCM_CONSP (tmp) && (SCM_CAR (tmp)==x))
+ SCM tmp = SCM_CAR (alist);
+ if (SCM_CONSP (tmp) && SCM_EQ_P (SCM_CAR (tmp), key))
return tmp;
}
return SCM_BOOL_F;
}
+#undef FUNC_NAME
-SCM_PROC (s_sloppy_assv, "sloppy-assv", 2, 0, 0, scm_sloppy_assv);
-
-SCM
-scm_sloppy_assv(x, alist)
- SCM x;
- SCM alist;
+SCM_DEFINE (scm_sloppy_assv, "sloppy-assv", 2, 0, 0,
+ (SCM key, SCM alist),
+ "Behaves like @code{assv} but does not do any error checking.\n"
+ "Recommended only for use in Guile internals.")
+#define FUNC_NAME s_scm_sloppy_assv
{
- for (; SCM_NIMP (alist) && SCM_CONSP (alist); alist = SCM_CDR (alist))
+ for (; SCM_CONSP (alist); alist = SCM_CDR (alist))
{
- SCM tmp = SCM_CAR(alist);
- if (SCM_NIMP (tmp)
- && SCM_CONSP (tmp)
- && SCM_NFALSEP (scm_eqv_p (SCM_CAR (tmp), x)))
+ SCM tmp = SCM_CAR (alist);
+ if (SCM_CONSP (tmp)
+ && SCM_NFALSEP (scm_eqv_p (SCM_CAR (tmp), key)))
return tmp;
}
return SCM_BOOL_F;
}
+#undef FUNC_NAME
-SCM_PROC (s_sloppy_assoc, "sloppy-assoc", 2, 0, 0, scm_sloppy_assoc);
-
-SCM
-scm_sloppy_assoc(x, alist)
- SCM x;
- SCM alist;
+SCM_DEFINE (scm_sloppy_assoc, "sloppy-assoc", 2, 0, 0,
+ (SCM key, SCM alist),
+ "Behaves like @code{assoc} but does not do any error checking.\n"
+ "Recommended only for use in Guile internals.")
+#define FUNC_NAME s_scm_sloppy_assoc
{
- for (; SCM_NIMP (alist) && SCM_CONSP (alist); alist = SCM_CDR (alist))
+ for (; SCM_CONSP (alist); alist = SCM_CDR (alist))
{
- SCM tmp = SCM_CAR(alist);
- if (SCM_NIMP (tmp)
- && SCM_CONSP (tmp)
- && SCM_NFALSEP (scm_equal_p (SCM_CAR (tmp), x)))
+ SCM tmp = SCM_CAR (alist);
+ if (SCM_CONSP (tmp)
+ && SCM_NFALSEP (scm_equal_p (SCM_CAR (tmp), key)))
return tmp;
}
return SCM_BOOL_F;
}
+#undef FUNC_NAME
\f
-SCM_PROC(s_assq, "assq", 2, 0, 0, scm_assq);
-
-SCM
-scm_assq(x, alist)
- SCM x;
- SCM alist;
+SCM_DEFINE (scm_assq, "assq", 2, 0, 0,
+ (SCM key, SCM alist),
+ "@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 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
{
- SCM tmp;
- for(;SCM_NIMP(alist);alist = SCM_CDR(alist)) {
- SCM_ASSERT(SCM_CONSP(alist), alist, SCM_ARG2, s_assq);
- tmp = SCM_CAR(alist);
- SCM_ASSERT(SCM_NIMP(tmp) && SCM_CONSP(tmp), alist, SCM_ARG2, s_assq);
- if (SCM_CAR(tmp)==x) return tmp;
- }
- SCM_ASSERT(SCM_NULLP(alist), alist, SCM_ARG2, s_assq);
- return SCM_BOOL_F;
+ SCM ls = alist;
+ for (; SCM_CONSP (ls); ls = SCM_CDR (ls))
+ {
+ SCM tmp = SCM_CAR (ls);
+ SCM_ASSERT_TYPE (SCM_CONSP (tmp), alist, SCM_ARG2, FUNC_NAME,
+ "association list");
+ if (SCM_EQ_P (SCM_CAR (tmp), key))
+ return tmp;
+ }
+ SCM_ASSERT_TYPE (SCM_NULL_OR_NIL_P (ls), alist, SCM_ARG2, FUNC_NAME,
+ "association list");
+ return SCM_BOOL_F;
}
+#undef FUNC_NAME
-SCM_PROC(s_assv, "assv", 2, 0, 0, scm_assv);
-
-SCM
-scm_assv(x, alist)
- SCM x;
- SCM alist;
+SCM_DEFINE (scm_assv, "assv", 2, 0, 0,
+ (SCM key, SCM alist),
+ "Behaves like @code{assq} but uses @code{eqv?} for key comparison.")
+#define FUNC_NAME s_scm_assv
{
- SCM tmp;
- for(;SCM_NIMP(alist);alist = SCM_CDR(alist)) {
- SCM_ASRTGO(SCM_CONSP(alist), badlst);
- tmp = SCM_CAR(alist);
- SCM_ASRTGO(SCM_NIMP(tmp) && SCM_CONSP(tmp), badlst);
- if SCM_NFALSEP(scm_eqv_p(SCM_CAR(tmp), x)) return tmp;
- }
-# ifndef SCM_RECKLESS
- if (!(SCM_NULLP(alist)))
- badlst: scm_wta(alist, (char *)SCM_ARG2, s_assv);
-# endif
+ SCM ls = alist;
+ for(; SCM_CONSP (ls); ls = SCM_CDR (ls))
+ {
+ SCM tmp = SCM_CAR (ls);
+ SCM_ASSERT_TYPE (SCM_CONSP (tmp), alist, SCM_ARG2, FUNC_NAME,
+ "association list");
+ if (SCM_NFALSEP (scm_eqv_p (SCM_CAR (tmp), key)))
+ return tmp;
+ }
+ SCM_ASSERT_TYPE (SCM_NULL_OR_NIL_P (ls), alist, SCM_ARG2, FUNC_NAME,
+ "association list");
return SCM_BOOL_F;
}
+#undef FUNC_NAME
-SCM_PROC(s_assoc, "assoc", 2, 0, 0, scm_assoc);
-
-SCM
-scm_assoc(x, alist)
- SCM x;
- SCM alist;
+SCM_DEFINE (scm_assoc, "assoc", 2, 0, 0,
+ (SCM key, SCM alist),
+ "Behaves like @code{assq} but uses @code{equal?} for key comparison.")
+#define FUNC_NAME s_scm_assoc
{
- SCM tmp;
- for(;SCM_NIMP(alist);alist = SCM_CDR(alist)) {
- SCM_ASSERT(SCM_CONSP(alist), alist, SCM_ARG2, s_assoc);
- tmp = SCM_CAR(alist);
- SCM_ASSERT(SCM_NIMP(tmp) && SCM_CONSP(tmp), alist, SCM_ARG2, s_assoc);
- if SCM_NFALSEP(scm_equal_p(SCM_CAR(tmp), x)) return tmp;
- }
- SCM_ASSERT(SCM_NULLP(alist), alist, SCM_ARG2, s_assoc);
- return SCM_BOOL_F;
+ SCM ls = alist;
+ for(; SCM_CONSP (ls); ls = SCM_CDR (ls))
+ {
+ SCM tmp = SCM_CAR (ls);
+ SCM_ASSERT_TYPE (SCM_CONSP (tmp), alist, SCM_ARG2, FUNC_NAME,
+ "association list");
+ if (SCM_NFALSEP (scm_equal_p (SCM_CAR (tmp), key)))
+ return tmp;
+ }
+ SCM_ASSERT_TYPE (SCM_NULL_OR_NIL_P (ls), alist, SCM_ARG2, FUNC_NAME,
+ "association list");
+ return SCM_BOOL_F;
}
+#undef FUNC_NAME
\f
-SCM_PROC (s_assq_ref, "assq-ref", 2, 0, 0, scm_assq_ref);
-
-SCM
-scm_assq_ref (alist, key)
- SCM alist;
- SCM key;
+/* 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 {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"
+ "@lisp\n"
+ "(let ((ent (@var{associator} @var{key} @var{alist})))\n"
+ " (and ent (cdr ent)))\n"
+ "@end lisp\n\n"
+ "where @var{associator} is one of @code{assq}, @code{assv} or @code{assoc}.")
+#define FUNC_NAME s_scm_assq_ref
{
SCM handle;
handle = scm_sloppy_assq (key, alist);
- if (SCM_NIMP (handle) && SCM_CONSP (handle))
+ if (SCM_CONSP (handle))
{
return SCM_CDR (handle);
}
return SCM_BOOL_F;
}
+#undef FUNC_NAME
-SCM_PROC (s_assv_ref, "assv-ref", 2, 0, 0, scm_assv_ref);
-
-SCM
-scm_assv_ref (alist, key)
- SCM alist;
- SCM key;
+SCM_DEFINE (scm_assv_ref, "assv-ref", 2, 0, 0,
+ (SCM alist, SCM key),
+ "Behaves like @code{assq-ref} but uses @code{eqv?} for key comparison.")
+#define FUNC_NAME s_scm_assv_ref
{
SCM handle;
handle = scm_sloppy_assv (key, alist);
- if (SCM_NIMP (handle) && SCM_CONSP (handle))
+ if (SCM_CONSP (handle))
{
return SCM_CDR (handle);
}
return SCM_BOOL_F;
}
+#undef FUNC_NAME
-SCM_PROC (s_assoc_ref, "assoc-ref", 2, 0, 0, scm_assoc_ref);
-
-SCM
-scm_assoc_ref (alist, key)
- SCM alist;
- SCM key;
+SCM_DEFINE (scm_assoc_ref, "assoc-ref", 2, 0, 0,
+ (SCM alist, SCM key),
+ "Behaves like @code{assq-ref} but uses @code{equal?} for key comparison.")
+#define FUNC_NAME s_scm_assoc_ref
{
SCM handle;
handle = scm_sloppy_assoc (key, alist);
- if (SCM_NIMP (handle) && SCM_CONSP (handle))
+ if (SCM_CONSP (handle))
{
return SCM_CDR (handle);
}
return SCM_BOOL_F;
}
+#undef FUNC_NAME
\f
-SCM_PROC (s_assq_set_x, "assq-set!", 3, 0, 0, scm_assq_set_x);
-
-SCM
-scm_assq_set_x (alist, key, val)
- SCM alist;
- SCM key;
- SCM val;
+SCM_DEFINE (scm_assq_set_x, "assq-set!", 3, 0, 0,
+ (SCM alist, SCM key, SCM val),
+ "@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"
+ "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"
+ "association list.")
+#define FUNC_NAME s_scm_assq_set_x
{
SCM handle;
handle = scm_sloppy_assq (key, alist);
- if (SCM_NIMP (handle) && SCM_CONSP (handle))
+ if (SCM_CONSP (handle))
{
SCM_SETCDR (handle, val);
return alist;
else
return scm_acons (key, val, alist);
}
+#undef FUNC_NAME
-SCM_PROC (s_assv_set_x, "assv-set!", 3, 0, 0, scm_assv_set_x);
-
-SCM
-scm_assv_set_x (alist, key, val)
- SCM alist;
- SCM key;
- SCM val;
+SCM_DEFINE (scm_assv_set_x, "assv-set!", 3, 0, 0,
+ (SCM alist, SCM key, SCM val),
+ "Behaves like @code{assq-set!} but uses @code{eqv?} for key comparison.")
+#define FUNC_NAME s_scm_assv_set_x
{
SCM handle;
handle = scm_sloppy_assv (key, alist);
- if (SCM_NIMP (handle) && SCM_CONSP (handle))
+ if (SCM_CONSP (handle))
{
SCM_SETCDR (handle, val);
return alist;
else
return scm_acons (key, val, alist);
}
+#undef FUNC_NAME
-SCM_PROC (s_assoc_set_x, "assoc-set!", 3, 0, 0, scm_assoc_set_x);
-
-SCM
-scm_assoc_set_x (alist, key, val)
- SCM alist;
- SCM key;
- SCM val;
+SCM_DEFINE (scm_assoc_set_x, "assoc-set!", 3, 0, 0,
+ (SCM alist, SCM key, SCM val),
+ "Behaves like @code{assq-set!} but uses @code{equal?} for key comparison.")
+#define FUNC_NAME s_scm_assoc_set_x
{
SCM handle;
handle = scm_sloppy_assoc (key, alist);
- if (SCM_NIMP (handle) && SCM_CONSP (handle))
+ if (SCM_CONSP (handle))
{
SCM_SETCDR (handle, val);
return alist;
else
return scm_acons (key, val, alist);
}
+#undef FUNC_NAME
\f
-SCM_PROC (s_assq_remove_x, "assq-remove!", 2, 0, 0, scm_assq_remove_x);
-
-SCM
-scm_assq_remove_x (alist, key)
- SCM alist;
- SCM key;
+SCM_DEFINE (scm_assq_remove_x, "assq-remove!", 2, 0, 0,
+ (SCM alist, SCM key),
+ "@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
{
SCM handle;
handle = scm_sloppy_assq (key, alist);
- if (SCM_NIMP (handle) && SCM_CONSP (handle))
- {
- return scm_delq_x (handle, alist);
- }
- else
- return alist;
-}
+ if (SCM_CONSP (handle))
+ alist = scm_delq1_x (handle, alist);
+ return alist;
+}
+#undef FUNC_NAME
-SCM_PROC (s_assv_remove_x, "assv-remove!", 2, 0, 0, scm_assv_remove_x);
-SCM
-scm_assv_remove_x (alist, key)
- SCM alist;
- SCM key;
+SCM_DEFINE (scm_assv_remove_x, "assv-remove!", 2, 0, 0,
+ (SCM alist, SCM key),
+ "Behaves like @code{assq-remove!} but uses @code{eqv?} for key comparison.")
+#define FUNC_NAME s_scm_assv_remove_x
{
SCM handle;
handle = scm_sloppy_assv (key, alist);
- if (SCM_NIMP (handle) && SCM_CONSP (handle))
- {
- return scm_delv_x (handle, alist);
- }
- else
- return alist;
-}
+ if (SCM_CONSP (handle))
+ alist = scm_delq1_x (handle, alist);
+ return alist;
+}
+#undef FUNC_NAME
-SCM_PROC (s_assoc_remove_x, "assoc-remove!", 2, 0, 0, scm_assoc_remove_x);
-SCM
-scm_assoc_remove_x (alist, key)
- SCM alist;
- SCM key;
+SCM_DEFINE (scm_assoc_remove_x, "assoc-remove!", 2, 0, 0,
+ (SCM alist, SCM key),
+ "Behaves like @code{assq-remove!} but uses @code{equal?} for key comparison.")
+#define FUNC_NAME s_scm_assoc_remove_x
{
SCM handle;
handle = scm_sloppy_assoc (key, alist);
- if (SCM_NIMP (handle) && SCM_CONSP (handle))
- {
- return scm_delete_x (handle, alist);
- }
- else
- return alist;
+ if (SCM_CONSP (handle))
+ alist = scm_delq1_x (handle, alist);
+
+ return alist;
}
+#undef FUNC_NAME
\f
void
scm_init_alist ()
{
-#include "alist.x"
+#ifndef SCM_MAGIC_SNARFER
+#include "libguile/alist.x"
+#endif
}
+
+/*
+ Local Variables:
+ c-file-style: "gnu"
+ End:
+*/
HCoop / bpt / guile.git / blobdiff