Commit | Line | Data |
---|---|---|
8c0e89ac | 1 | /* Copyright (C) 1995, 96, 97, 98, 99, 2000, 2001, 2004, 2006, 2008, 2010, 2011 Free Software Foundation, Inc. |
0f2d19dd | 2 | * |
73be1d9e | 3 | * This library is free software; you can redistribute it and/or |
53befeb7 NJ |
4 | * modify it under the terms of the GNU Lesser General Public License |
5 | * as published by the Free Software Foundation; either version 3 of | |
6 | * the License, or (at your option) any later version. | |
0f2d19dd | 7 | * |
53befeb7 NJ |
8 | * This library is distributed in the hope that it will be useful, but |
9 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
73be1d9e MV |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
11 | * Lesser General Public License for more details. | |
0f2d19dd | 12 | * |
73be1d9e MV |
13 | * You should have received a copy of the GNU Lesser General Public |
14 | * License along with this library; if not, write to the Free Software | |
53befeb7 NJ |
15 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
16 | * 02110-1301 USA | |
73be1d9e | 17 | */ |
1bbd0b84 | 18 | |
1bbd0b84 | 19 | |
0f2d19dd | 20 | \f |
dbb605f5 LC |
21 | #ifdef HAVE_CONFIG_H |
22 | # include <config.h> | |
23 | #endif | |
24 | ||
a0599745 MD |
25 | #include "libguile/_scm.h" |
26 | #include "libguile/eq.h" | |
27 | #include "libguile/list.h" | |
20e6290e | 28 | |
a0599745 | 29 | #include "libguile/validate.h" |
d2e53ed6 | 30 | #include "libguile/pairs.h" |
a0599745 | 31 | #include "libguile/alist.h" |
0f2d19dd JB |
32 | |
33 | \f | |
34 | ||
3b3b36dd | 35 | SCM_DEFINE (scm_acons, "acons", 3, 0, 0, |
0b5f3f34 | 36 | (SCM key, SCM value, SCM alist), |
8f85c0c6 | 37 | "Add a new key-value pair to @var{alist}. A new pair is\n" |
b380b885 MD |
38 | "created whose car is @var{key} and whose cdr is @var{value}, and the\n" |
39 | "pair is consed onto @var{alist}, and the new list is returned. This\n" | |
40 | "function is @emph{not} destructive; @var{alist} is not modified.") | |
1bbd0b84 | 41 | #define FUNC_NAME s_scm_acons |
0f2d19dd | 42 | { |
8c0e89ac | 43 | return scm_cons (scm_cons (key, value), alist); |
0f2d19dd | 44 | } |
1bbd0b84 | 45 | #undef FUNC_NAME |
0f2d19dd JB |
46 | |
47 | \f | |
48 | ||
a1ec6916 | 49 | SCM_DEFINE (scm_sloppy_assq, "sloppy-assq", 2, 0, 0, |
0b5f3f34 | 50 | (SCM key, SCM alist), |
b380b885 MD |
51 | "Behaves like @code{assq} but does not do any error checking.\n" |
52 | "Recommended only for use in Guile internals.") | |
1bbd0b84 | 53 | #define FUNC_NAME s_scm_sloppy_assq |
0f2d19dd | 54 | { |
d2e53ed6 | 55 | for (; scm_is_pair (alist); alist = SCM_CDR (alist)) |
0f2d19dd | 56 | { |
2de257bd | 57 | SCM tmp = SCM_CAR (alist); |
d2e53ed6 | 58 | if (scm_is_pair (tmp) && scm_is_eq (SCM_CAR (tmp), key)) |
cf18adf0 | 59 | return tmp; |
0f2d19dd JB |
60 | } |
61 | return SCM_BOOL_F; | |
62 | } | |
1bbd0b84 | 63 | #undef FUNC_NAME |
0f2d19dd JB |
64 | |
65 | ||
66 | ||
a1ec6916 | 67 | SCM_DEFINE (scm_sloppy_assv, "sloppy-assv", 2, 0, 0, |
0b5f3f34 | 68 | (SCM key, SCM alist), |
b380b885 MD |
69 | "Behaves like @code{assv} but does not do any error checking.\n" |
70 | "Recommended only for use in Guile internals.") | |
1bbd0b84 | 71 | #define FUNC_NAME s_scm_sloppy_assv |
0f2d19dd | 72 | { |
d2e53ed6 | 73 | for (; scm_is_pair (alist); alist = SCM_CDR (alist)) |
0f2d19dd | 74 | { |
2de257bd | 75 | SCM tmp = SCM_CAR (alist); |
d2e53ed6 | 76 | if (scm_is_pair (tmp) |
7888309b | 77 | && scm_is_true (scm_eqv_p (SCM_CAR (tmp), key))) |
cf18adf0 | 78 | return tmp; |
0f2d19dd JB |
79 | } |
80 | return SCM_BOOL_F; | |
81 | } | |
1bbd0b84 | 82 | #undef FUNC_NAME |
0f2d19dd JB |
83 | |
84 | ||
a1ec6916 | 85 | SCM_DEFINE (scm_sloppy_assoc, "sloppy-assoc", 2, 0, 0, |
0b5f3f34 | 86 | (SCM key, SCM alist), |
b380b885 MD |
87 | "Behaves like @code{assoc} but does not do any error checking.\n" |
88 | "Recommended only for use in Guile internals.") | |
1bbd0b84 | 89 | #define FUNC_NAME s_scm_sloppy_assoc |
0f2d19dd | 90 | { |
d2e53ed6 | 91 | for (; scm_is_pair (alist); alist = SCM_CDR (alist)) |
0f2d19dd | 92 | { |
2de257bd | 93 | SCM tmp = SCM_CAR (alist); |
d2e53ed6 | 94 | if (scm_is_pair (tmp) |
7888309b | 95 | && scm_is_true (scm_equal_p (SCM_CAR (tmp), key))) |
cf18adf0 | 96 | return tmp; |
0f2d19dd JB |
97 | } |
98 | return SCM_BOOL_F; | |
99 | } | |
1bbd0b84 | 100 | #undef FUNC_NAME |
0f2d19dd JB |
101 | |
102 | ||
103 | \f | |
104 | ||
3b3b36dd | 105 | SCM_DEFINE (scm_assq, "assq", 2, 0, 0, |
0b5f3f34 | 106 | (SCM key, SCM alist), |
8f85c0c6 NJ |
107 | "@deffnx {Scheme Procedure} assv key alist\n" |
108 | "@deffnx {Scheme Procedure} assoc key alist\n" | |
109 | "Fetch the entry in @var{alist} that is associated with @var{key}. To\n" | |
b380b885 MD |
110 | "decide whether the argument @var{key} matches a particular entry in\n" |
111 | "@var{alist}, @code{assq} compares keys with @code{eq?}, @code{assv}\n" | |
112 | "uses @code{eqv?} and @code{assoc} uses @code{equal?}. If @var{key}\n" | |
113 | "cannot be found in @var{alist} (according to whichever equality\n" | |
8f85c0c6 | 114 | "predicate is in use), then return @code{#f}. These functions\n" |
b380b885 | 115 | "return the entire alist entry found (i.e. both the key and the value).") |
1bbd0b84 | 116 | #define FUNC_NAME s_scm_assq |
0f2d19dd | 117 | { |
1aa621a3 | 118 | SCM ls = alist; |
d2e53ed6 | 119 | for(; scm_is_pair (ls); ls = SCM_CDR (ls)) |
e1385ffc | 120 | { |
1aa621a3 | 121 | SCM tmp = SCM_CAR (ls); |
d2e53ed6 | 122 | SCM_ASSERT_TYPE (scm_is_pair (tmp), alist, SCM_ARG2, FUNC_NAME, |
1aa621a3 | 123 | "association list"); |
bc36d050 | 124 | if (scm_is_eq (SCM_CAR (tmp), key)) |
2de257bd | 125 | return tmp; |
e1385ffc | 126 | } |
c96d76b8 | 127 | SCM_ASSERT_TYPE (SCM_NULL_OR_NIL_P (ls), alist, SCM_ARG2, FUNC_NAME, |
1aa621a3 | 128 | "association list"); |
1bbd0b84 | 129 | return SCM_BOOL_F; |
0f2d19dd | 130 | } |
1bbd0b84 | 131 | #undef FUNC_NAME |
0f2d19dd JB |
132 | |
133 | ||
3b3b36dd | 134 | SCM_DEFINE (scm_assv, "assv", 2, 0, 0, |
0b5f3f34 | 135 | (SCM key, SCM alist), |
b380b885 | 136 | "Behaves like @code{assq} but uses @code{eqv?} for key comparison.") |
1bbd0b84 | 137 | #define FUNC_NAME s_scm_assv |
0f2d19dd | 138 | { |
1aa621a3 | 139 | SCM ls = alist; |
d2e53ed6 | 140 | for(; scm_is_pair (ls); ls = SCM_CDR (ls)) |
e1385ffc | 141 | { |
1aa621a3 | 142 | SCM tmp = SCM_CAR (ls); |
d2e53ed6 | 143 | SCM_ASSERT_TYPE (scm_is_pair (tmp), alist, SCM_ARG2, FUNC_NAME, |
1aa621a3 | 144 | "association list"); |
7888309b | 145 | if (scm_is_true (scm_eqv_p (SCM_CAR (tmp), key))) |
2de257bd | 146 | return tmp; |
e1385ffc | 147 | } |
c96d76b8 | 148 | SCM_ASSERT_TYPE (SCM_NULL_OR_NIL_P (ls), alist, SCM_ARG2, FUNC_NAME, |
1aa621a3 | 149 | "association list"); |
0f2d19dd JB |
150 | return SCM_BOOL_F; |
151 | } | |
1bbd0b84 | 152 | #undef FUNC_NAME |
0f2d19dd JB |
153 | |
154 | ||
3b3b36dd | 155 | SCM_DEFINE (scm_assoc, "assoc", 2, 0, 0, |
0b5f3f34 | 156 | (SCM key, SCM alist), |
b380b885 | 157 | "Behaves like @code{assq} but uses @code{equal?} for key comparison.") |
1bbd0b84 | 158 | #define FUNC_NAME s_scm_assoc |
0f2d19dd | 159 | { |
1aa621a3 | 160 | SCM ls = alist; |
d2e53ed6 | 161 | for(; scm_is_pair (ls); ls = SCM_CDR (ls)) |
e1385ffc | 162 | { |
1aa621a3 | 163 | SCM tmp = SCM_CAR (ls); |
d2e53ed6 | 164 | SCM_ASSERT_TYPE (scm_is_pair (tmp), alist, SCM_ARG2, FUNC_NAME, |
1aa621a3 | 165 | "association list"); |
7888309b | 166 | if (scm_is_true (scm_equal_p (SCM_CAR (tmp), key))) |
2de257bd | 167 | return tmp; |
e1385ffc | 168 | } |
c96d76b8 | 169 | SCM_ASSERT_TYPE (SCM_NULL_OR_NIL_P (ls), alist, SCM_ARG2, FUNC_NAME, |
1aa621a3 | 170 | "association list"); |
1bbd0b84 | 171 | return SCM_BOOL_F; |
0f2d19dd | 172 | } |
1bbd0b84 | 173 | #undef FUNC_NAME |
0f2d19dd JB |
174 | |
175 | ||
176 | \f | |
177 | ||
d1ca2c64 DH |
178 | /* Dirk:API2.0:: We should not return #f if the key was not found. In the |
179 | * current solution we can not distinguish between finding a (key . #f) pair | |
180 | * and not finding the key at all. | |
181 | * | |
182 | * Possible alternative solutions: | |
183 | * 1) Remove assq-ref from the API: assq is sufficient. | |
184 | * 2) Signal an error (what error type?) if the key is not found. | |
185 | * 3) provide an additional 'default' parameter. | |
186 | * 3.1) The default parameter is mandatory. | |
187 | * 3.2) The default parameter is optional, but if no default is given and | |
188 | * the key is not found, signal an error (what error type?). | |
189 | */ | |
a1ec6916 | 190 | SCM_DEFINE (scm_assq_ref, "assq-ref", 2, 0, 0, |
1bbd0b84 | 191 | (SCM alist, SCM key), |
8f85c0c6 NJ |
192 | "@deffnx {Scheme Procedure} assv-ref alist key\n" |
193 | "@deffnx {Scheme Procedure} assoc-ref alist key\n" | |
b380b885 MD |
194 | "Like @code{assq}, @code{assv} and @code{assoc}, except that only the\n" |
195 | "value associated with @var{key} in @var{alist} is returned. These\n" | |
196 | "functions are equivalent to\n\n" | |
197 | "@lisp\n" | |
198 | "(let ((ent (@var{associator} @var{key} @var{alist})))\n" | |
199 | " (and ent (cdr ent)))\n" | |
200 | "@end lisp\n\n" | |
201 | "where @var{associator} is one of @code{assq}, @code{assv} or @code{assoc}.") | |
1bbd0b84 | 202 | #define FUNC_NAME s_scm_assq_ref |
0f2d19dd JB |
203 | { |
204 | SCM handle; | |
205 | ||
206 | handle = scm_sloppy_assq (key, alist); | |
d2e53ed6 | 207 | if (scm_is_pair (handle)) |
0f2d19dd JB |
208 | { |
209 | return SCM_CDR (handle); | |
210 | } | |
211 | return SCM_BOOL_F; | |
212 | } | |
1bbd0b84 | 213 | #undef FUNC_NAME |
0f2d19dd JB |
214 | |
215 | ||
a1ec6916 | 216 | SCM_DEFINE (scm_assv_ref, "assv-ref", 2, 0, 0, |
1bbd0b84 | 217 | (SCM alist, SCM key), |
b380b885 | 218 | "Behaves like @code{assq-ref} but uses @code{eqv?} for key comparison.") |
1bbd0b84 | 219 | #define FUNC_NAME s_scm_assv_ref |
0f2d19dd JB |
220 | { |
221 | SCM handle; | |
222 | ||
223 | handle = scm_sloppy_assv (key, alist); | |
d2e53ed6 | 224 | if (scm_is_pair (handle)) |
0f2d19dd JB |
225 | { |
226 | return SCM_CDR (handle); | |
227 | } | |
228 | return SCM_BOOL_F; | |
229 | } | |
1bbd0b84 | 230 | #undef FUNC_NAME |
0f2d19dd JB |
231 | |
232 | ||
a1ec6916 | 233 | SCM_DEFINE (scm_assoc_ref, "assoc-ref", 2, 0, 0, |
1bbd0b84 | 234 | (SCM alist, SCM key), |
b380b885 | 235 | "Behaves like @code{assq-ref} but uses @code{equal?} for key comparison.") |
1bbd0b84 | 236 | #define FUNC_NAME s_scm_assoc_ref |
0f2d19dd JB |
237 | { |
238 | SCM handle; | |
239 | ||
240 | handle = scm_sloppy_assoc (key, alist); | |
d2e53ed6 | 241 | if (scm_is_pair (handle)) |
0f2d19dd JB |
242 | { |
243 | return SCM_CDR (handle); | |
244 | } | |
245 | return SCM_BOOL_F; | |
246 | } | |
1bbd0b84 | 247 | #undef FUNC_NAME |
0f2d19dd JB |
248 | |
249 | ||
250 | ||
251 | \f | |
252 | ||
253 | ||
a1ec6916 | 254 | SCM_DEFINE (scm_assq_set_x, "assq-set!", 3, 0, 0, |
1bbd0b84 | 255 | (SCM alist, SCM key, SCM val), |
8f85c0c6 NJ |
256 | "@deffnx {Scheme Procedure} assv-set! alist key value\n" |
257 | "@deffnx {Scheme Procedure} assoc-set! alist key value\n" | |
b7e64f8b | 258 | "Reassociate @var{key} in @var{alist} with @var{val}: find any existing\n" |
b380b885 | 259 | "@var{alist} entry for @var{key} and associate it with the new\n" |
b7e64f8b | 260 | "@var{val}. If @var{alist} does not contain an entry for @var{key},\n" |
b380b885 MD |
261 | "add a new one. Return the (possibly new) alist.\n\n" |
262 | "These functions do not attempt to verify the structure of @var{alist},\n" | |
263 | "and so may cause unusual results if passed an object that is not an\n" | |
264 | "association list.") | |
1bbd0b84 | 265 | #define FUNC_NAME s_scm_assq_set_x |
0f2d19dd JB |
266 | { |
267 | SCM handle; | |
268 | ||
269 | handle = scm_sloppy_assq (key, alist); | |
d2e53ed6 | 270 | if (scm_is_pair (handle)) |
0f2d19dd JB |
271 | { |
272 | SCM_SETCDR (handle, val); | |
273 | return alist; | |
274 | } | |
275 | else | |
276 | return scm_acons (key, val, alist); | |
277 | } | |
1bbd0b84 | 278 | #undef FUNC_NAME |
0f2d19dd | 279 | |
a1ec6916 | 280 | SCM_DEFINE (scm_assv_set_x, "assv-set!", 3, 0, 0, |
1bbd0b84 | 281 | (SCM alist, SCM key, SCM val), |
b380b885 | 282 | "Behaves like @code{assq-set!} but uses @code{eqv?} for key comparison.") |
1bbd0b84 | 283 | #define FUNC_NAME s_scm_assv_set_x |
0f2d19dd JB |
284 | { |
285 | SCM handle; | |
286 | ||
287 | handle = scm_sloppy_assv (key, alist); | |
d2e53ed6 | 288 | if (scm_is_pair (handle)) |
0f2d19dd JB |
289 | { |
290 | SCM_SETCDR (handle, val); | |
291 | return alist; | |
292 | } | |
293 | else | |
294 | return scm_acons (key, val, alist); | |
295 | } | |
1bbd0b84 | 296 | #undef FUNC_NAME |
0f2d19dd | 297 | |
a1ec6916 | 298 | SCM_DEFINE (scm_assoc_set_x, "assoc-set!", 3, 0, 0, |
1bbd0b84 | 299 | (SCM alist, SCM key, SCM val), |
b380b885 | 300 | "Behaves like @code{assq-set!} but uses @code{equal?} for key comparison.") |
1bbd0b84 | 301 | #define FUNC_NAME s_scm_assoc_set_x |
0f2d19dd JB |
302 | { |
303 | SCM handle; | |
304 | ||
305 | handle = scm_sloppy_assoc (key, alist); | |
d2e53ed6 | 306 | if (scm_is_pair (handle)) |
0f2d19dd JB |
307 | { |
308 | SCM_SETCDR (handle, val); | |
309 | return alist; | |
310 | } | |
311 | else | |
312 | return scm_acons (key, val, alist); | |
313 | } | |
1bbd0b84 | 314 | #undef FUNC_NAME |
0f2d19dd JB |
315 | |
316 | ||
317 | \f | |
318 | ||
a1ec6916 | 319 | SCM_DEFINE (scm_assq_remove_x, "assq-remove!", 2, 0, 0, |
1bbd0b84 | 320 | (SCM alist, SCM key), |
8f85c0c6 NJ |
321 | "@deffnx {Scheme Procedure} assv-remove! alist key\n" |
322 | "@deffnx {Scheme Procedure} assoc-remove! alist key\n" | |
623ada63 | 323 | "Delete the first entry in @var{alist} associated with @var{key}, and return\n" |
b380b885 | 324 | "the resulting alist.") |
1bbd0b84 | 325 | #define FUNC_NAME s_scm_assq_remove_x |
0f2d19dd JB |
326 | { |
327 | SCM handle; | |
328 | ||
329 | handle = scm_sloppy_assq (key, alist); | |
d2e53ed6 | 330 | if (scm_is_pair (handle)) |
60e61f0a | 331 | alist = scm_delq1_x (handle, alist); |
623ada63 | 332 | |
5d253852 | 333 | return alist; |
0f2d19dd | 334 | } |
1bbd0b84 | 335 | #undef FUNC_NAME |
0f2d19dd JB |
336 | |
337 | ||
a1ec6916 | 338 | SCM_DEFINE (scm_assv_remove_x, "assv-remove!", 2, 0, 0, |
1bbd0b84 | 339 | (SCM alist, SCM key), |
b380b885 | 340 | "Behaves like @code{assq-remove!} but uses @code{eqv?} for key comparison.") |
1bbd0b84 | 341 | #define FUNC_NAME s_scm_assv_remove_x |
0f2d19dd JB |
342 | { |
343 | SCM handle; | |
344 | ||
345 | handle = scm_sloppy_assv (key, alist); | |
d2e53ed6 | 346 | if (scm_is_pair (handle)) |
60e61f0a | 347 | alist = scm_delq1_x (handle, alist); |
623ada63 | 348 | |
5d253852 | 349 | return alist; |
0f2d19dd | 350 | } |
1bbd0b84 | 351 | #undef FUNC_NAME |
0f2d19dd JB |
352 | |
353 | ||
a1ec6916 | 354 | SCM_DEFINE (scm_assoc_remove_x, "assoc-remove!", 2, 0, 0, |
1bbd0b84 | 355 | (SCM alist, SCM key), |
b380b885 | 356 | "Behaves like @code{assq-remove!} but uses @code{equal?} for key comparison.") |
1bbd0b84 | 357 | #define FUNC_NAME s_scm_assoc_remove_x |
0f2d19dd JB |
358 | { |
359 | SCM handle; | |
360 | ||
361 | handle = scm_sloppy_assoc (key, alist); | |
d2e53ed6 | 362 | if (scm_is_pair (handle)) |
60e61f0a | 363 | alist = scm_delq1_x (handle, alist); |
623ada63 | 364 | |
5d253852 | 365 | return alist; |
0f2d19dd | 366 | } |
1bbd0b84 | 367 | #undef FUNC_NAME |
0f2d19dd JB |
368 | |
369 | ||
370 | \f | |
371 | ||
372 | ||
1cc91f1b | 373 | |
0f2d19dd JB |
374 | void |
375 | scm_init_alist () | |
0f2d19dd | 376 | { |
a0599745 | 377 | #include "libguile/alist.x" |
0f2d19dd JB |
378 | } |
379 | ||
89e00824 ML |
380 | |
381 | /* | |
382 | Local Variables: | |
383 | c-file-style: "gnu" | |
384 | End: | |
385 | */ |