-/* Copyright (C) 1995,1996 Free Software Foundation, Inc.
+/* Copyright (C) 1995, 1996, 1998 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
*
* 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+ * 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.
*
* 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.
- */
+ * 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 "_scm.h"
#include "eq.h"
#include "list.h"
+#include "scm_validate.h"
#include "alist.h"
\f
-SCM_PROC(s_acons, "acons", 3, 0, 0, scm_acons);
-
-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),
+"Adds a new key-value pair to @var{alist}. A new pair is
+created whose car is @var{key} and whose cdr is @var{value}, and the
+pair is consed onto @var{alist}, and the new list is returned. This
+function is @emph{not} destructive; @var{alist} is not modified.")
+#define FUNC_NAME s_scm_acons
{
- register SCM z;
- SCM_NEWCELL (z);
- SCM_CAR (z) = w;
- SCM_CDR (z) = x;
- x = z;
- SCM_NEWCELL (z);
- SCM_CAR (z) = x;
- SCM_CDR (z) = y;
- return z;
+ SCM pair;
+ SCM head;
+
+ SCM_NEWCELL (pair);
+ SCM_SETCAR (pair, key);
+ SCM_SETCDR (pair, value);
+
+ SCM_NEWCELL (head);
+ SCM_SETCAR (head, pair);
+ SCM_SETCDR (head, alist);
+
+ return head;
}
+#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.
+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))
+ if (SCM_CONSP (tmp) && (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.
+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)))
+ 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.
+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)))
+ 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 primitive assv key alist
+@deffnx primitive assoc key alist
+Fetches the entry in @var{alist} that is associated with @var{key}. To
+decide whether the argument @var{key} matches a particular entry in
+@var{alist}, @code{assq} compares keys with @code{eq?}, @code{assv}
+uses @code{eqv?} and @code{assoc} uses @code{equal?}. If @var{key}
+cannot be found in @var{alist} (according to whichever equality
+predicate is in use), then @code{#f} is returned. These functions
+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 tmp;
+ for(;SCM_NIMP(alist);alist = SCM_CDR(alist)) {
+ SCM_VALIDATE_ALISTCELL_COPYSCM(2,alist,tmp);
+ if (SCM_CAR(tmp)==key) return tmp;
+ }
+ SCM_VALIDATE_NULL(2,alist);
+ 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;
+ SCM_ASRTGO(SCM_CONSP(tmp), badlst);
+ if SCM_NFALSEP(scm_eqv_p(SCM_CAR(tmp), key)) return tmp;
}
-# ifndef RECKLESS
+# ifndef SCM_RECKLESS
if (!(SCM_NULLP(alist)))
- badlst: scm_wta(alist, (char *)SCM_ARG2, s_assv);
+ badlst: SCM_WTA(2,alist);
# endif
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 tmp;
+ for(;SCM_NIMP(alist);alist = SCM_CDR(alist)) {
+ SCM_VALIDATE_ALISTCELL_COPYSCM(2,alist,tmp);
+ if SCM_NFALSEP(scm_equal_p(SCM_CAR(tmp), key)) return tmp;
+ }
+ SCM_VALIDATE_NULL(2,alist);
+ 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;
+SCM_DEFINE (scm_assq_ref, "assq-ref", 2, 0, 0,
+ (SCM alist, SCM key),
+"@deffnx primitive assv-ref alist key
+@deffnx primitive assoc-ref alist key
+Like @code{assq}, @code{assv} and @code{assoc}, except that only the
+value associated with @var{key} in @var{alist} is returned. These
+functions are equivalent to
+
+@lisp
+(let ((ent (@var{associator} @var{key} @var{alist})))
+ (and ent (cdr ent)))
+@end lisp
+
+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_DEFINE (scm_assq_set_x, "assq-set!", 3, 0, 0,
+ (SCM alist, SCM key, SCM val),
+"@deffnx primitive assv-set! alist key value
+@deffnx primitive assoc-set! alist key value
+Reassociate @var{key} in @var{alist} with @var{value}: find any existing
+@var{alist} entry for @var{key} and associate it with the new
+@var{value}. If @var{alist} does not contain an entry for @var{key},
+add a new one. Return the (possibly new) alist.
-SCM
-scm_assq_set_x (alist, key, val)
- SCM alist;
- SCM key;
- SCM val;
+These functions do not attempt to verify the structure of @var{alist},
+and so may cause unusual results if passed an object that is not an
+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 primitive assv-remove! alist key
+@deffnx primitive assoc-remove! alist key
+Delete any entry in @var{alist} associated with @var{key}, and return
+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))
+ if (SCM_CONSP (handle))
{
return scm_delq_x (handle, alist);
}
else
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))
+ if (SCM_CONSP (handle))
{
return scm_delv_x (handle, alist);
}
else
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))
+ if (SCM_CONSP (handle))
{
return scm_delete_x (handle, alist);
}
else
return alist;
}
+#undef FUNC_NAME
\f
HCoop / bpt / guile.git / blobdiff