1 /* Copyright (C) 1995, 1996, 1998, 1999, 2000 Free Software Foundation, Inc.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
43 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
48 #include "libguile/_scm.h"
49 #include "libguile/alist.h"
50 #include "libguile/hash.h"
51 #include "libguile/eval.h"
52 #include "libguile/vectors.h"
54 #include "libguile/validate.h"
55 #include "libguile/hashtab.h"
60 scm_hash_fn_get_handle (SCM table
,SCM obj
,unsigned int (*hash_fn
)(),SCM (*assoc_fn
)(),void * closure
)
65 SCM_ASSERT (SCM_VECTORP (table
), table
, SCM_ARG1
, "hash_fn_get_handle");
66 if (SCM_LENGTH (table
) == 0)
68 k
= hash_fn (obj
, SCM_LENGTH (table
), closure
);
69 SCM_ASSERT ((0 <= k
) && (k
< SCM_LENGTH (table
)),
72 "hash_fn_get_handle");
73 h
= assoc_fn (obj
, SCM_VELTS (table
)[k
], closure
);
80 scm_hash_fn_create_handle_x (SCM table
,SCM obj
,SCM init
,unsigned int (*hash_fn
)(),
81 SCM (*assoc_fn
)(),void * closure
)
86 SCM_ASSERT (SCM_VECTORP (table
), table
, SCM_ARG1
, "hash_fn_create_handle_x");
87 if (SCM_LENGTH (table
) == 0)
89 k
= hash_fn (obj
, SCM_LENGTH (table
), closure
);
90 SCM_ASSERT ((0 <= k
) && (k
< SCM_LENGTH (table
)),
93 "hash_fn_create_handle_x");
95 it
= assoc_fn (obj
, SCM_VELTS (table
)[k
], closure
);
104 old_bucket
= SCM_VELTS (table
)[k
];
105 new_bucket
= scm_acons (obj
, init
, old_bucket
);
106 SCM_VELTS(table
)[k
] = new_bucket
;
108 return SCM_CAR (new_bucket
);
116 scm_hash_fn_ref (SCM table
,SCM obj
,SCM dflt
,unsigned int (*hash_fn
)(),
117 SCM (*assoc_fn
)(),void * closure
)
121 it
= scm_hash_fn_get_handle (table
, obj
, hash_fn
, assoc_fn
, closure
);
132 scm_hash_fn_set_x (SCM table
,SCM obj
,SCM val
,unsigned int (*hash_fn
)(),
133 SCM (*assoc_fn
)(),void * closure
)
137 it
= scm_hash_fn_create_handle_x (table
, obj
, SCM_BOOL_F
, hash_fn
, assoc_fn
, closure
);
138 SCM_SETCDR (it
, val
);
147 scm_hash_fn_remove_x (SCM table
,SCM obj
,unsigned int (*hash_fn
)(),SCM (*assoc_fn
)(),
148 SCM (*delete_fn
)(),void * closure
)
153 SCM_ASSERT (SCM_VECTORP (table
), table
, SCM_ARG1
, "hash_fn_remove_x");
154 if (SCM_LENGTH (table
) == 0)
156 k
= hash_fn (obj
, SCM_LENGTH (table
), closure
);
157 SCM_ASSERT ((0 <= k
) && (k
< SCM_LENGTH (table
)),
161 h
= assoc_fn (obj
, SCM_VELTS (table
)[k
], closure
);
162 SCM_VELTS(table
)[k
] = delete_fn (h
, SCM_VELTS(table
)[k
]);
169 SCM_DEFINE (scm_hashq_get_handle
, "hashq-get-handle", 2, 0, 0,
170 (SCM table
, SCM obj
),
171 "This procedure is similar to its @code{-ref} cousin, but returns a\n"
172 "@dfn{handle} from the hash table rather than the value associated with\n"
173 "@var{key}. By convention, a handle in a hash table is the pair which\n"
174 "associates a key with a value. Where @code{hashq-ref table key} returns\n"
175 "only a @code{value}, @code{hashq-get-handle table key} returns the pair\n"
176 "@code{(key . value)}.")
177 #define FUNC_NAME s_scm_hashq_get_handle
179 return scm_hash_fn_get_handle (table
, obj
, scm_ihashq
, scm_sloppy_assq
, 0);
184 SCM_DEFINE (scm_hashq_create_handle_x
, "hashq-create-handle!", 3, 0, 0,
185 (SCM table
, SCM key
, SCM init
),
186 "This function looks up @var{key} in @var{table} and returns its handle.\n"
187 "If @var{key} is not already present, a new handle is created which\n"
188 "associates @var{key} with @var{init}.")
189 #define FUNC_NAME s_scm_hashq_create_handle_x
191 return scm_hash_fn_create_handle_x (table
, key
, init
, scm_ihashq
, scm_sloppy_assq
, 0);
196 SCM_DEFINE (scm_hashq_ref
, "hashq-ref", 2, 1, 0,
197 (SCM table
, SCM obj
, SCM dflt
),
198 "Look up @var{key} in the hash table @var{table}, and return the\n"
199 "value (if any) associated with it. If @var{key} is not found,\n"
200 "return @var{default} (or @code{#f} if no @var{default} argument is\n"
201 "supplied). Uses `eq?' for equality testing.")
202 #define FUNC_NAME s_scm_hashq_ref
204 if (SCM_UNBNDP (dflt
))
206 return scm_hash_fn_ref (table
, obj
, dflt
, scm_ihashq
, scm_sloppy_assq
, 0);
212 SCM_DEFINE (scm_hashq_set_x
, "hashq-set!", 3, 0, 0,
213 (SCM table
, SCM obj
, SCM val
),
214 "Find the entry in @var{table} associated with @var{key}, and store\n"
215 "@var{value} there. Uses `eq?' for equality testing.")
216 #define FUNC_NAME s_scm_hashq_set_x
218 return scm_hash_fn_set_x (table
, obj
, val
, scm_ihashq
, scm_sloppy_assq
, 0);
224 SCM_DEFINE (scm_hashq_remove_x
, "hashq-remove!", 2, 0, 0,
225 (SCM table
, SCM obj
),
226 "Remove @var{key} (and any value associated with it) from @var{table}.\n"
227 "Uses `eq?' for equality tests.")
228 #define FUNC_NAME s_scm_hashq_remove_x
230 return scm_hash_fn_remove_x (table
, obj
, scm_ihashq
, scm_sloppy_assq
, scm_delq_x
, 0);
237 SCM_DEFINE (scm_hashv_get_handle
, "hashv-get-handle", 2, 0, 0,
238 (SCM table
, SCM obj
),
239 "This procedure is similar to its @code{-ref} cousin, but returns a\n"
240 "@dfn{handle} from the hash table rather than the value associated with\n"
241 "@var{key}. By convention, a handle in a hash table is the pair which\n"
242 "associates a key with a value. Where @code{hashv-ref table key} returns\n"
243 "only a @code{value}, @code{hashv-get-handle table key} returns the pair\n"
244 "@code{(key . value)}.")
245 #define FUNC_NAME s_scm_hashv_get_handle
247 return scm_hash_fn_get_handle (table
, obj
, scm_ihashv
, scm_sloppy_assv
, 0);
252 SCM_DEFINE (scm_hashv_create_handle_x
, "hashv-create-handle!", 3, 0, 0,
253 (SCM table
, SCM key
, SCM init
),
254 "This function looks up @var{key} in @var{table} and returns its handle.\n"
255 "If @var{key} is not already present, a new handle is created which\n"
256 "associates @var{key} with @var{init}.")
257 #define FUNC_NAME s_scm_hashv_create_handle_x
259 return scm_hash_fn_create_handle_x (table
, key
, init
, scm_ihashv
, scm_sloppy_assv
, 0);
264 SCM_DEFINE (scm_hashv_ref
, "hashv-ref", 2, 1, 0,
265 (SCM table
, SCM obj
, SCM dflt
),
266 "Look up @var{key} in the hash table @var{table}, and return the\n"
267 "value (if any) associated with it. If @var{key} is not found,\n"
268 "return @var{default} (or @code{#f} if no @var{default} argument is\n"
269 "supplied). Uses `eqv?' for equality testing.")
270 #define FUNC_NAME s_scm_hashv_ref
272 if (SCM_UNBNDP (dflt
))
274 return scm_hash_fn_ref (table
, obj
, dflt
, scm_ihashv
, scm_sloppy_assv
, 0);
280 SCM_DEFINE (scm_hashv_set_x
, "hashv-set!", 3, 0, 0,
281 (SCM table
, SCM obj
, SCM val
),
282 "Find the entry in @var{table} associated with @var{key}, and store\n"
283 "@var{value} there. Uses `eqv?' for equality testing.")
284 #define FUNC_NAME s_scm_hashv_set_x
286 return scm_hash_fn_set_x (table
, obj
, val
, scm_ihashv
, scm_sloppy_assv
, 0);
291 SCM_DEFINE (scm_hashv_remove_x
, "hashv-remove!", 2, 0, 0,
292 (SCM table
, SCM obj
),
293 "Remove @var{key} (and any value associated with it) from @var{table}.\n"
294 "Uses `eqv?' for equality tests.")
295 #define FUNC_NAME s_scm_hashv_remove_x
297 return scm_hash_fn_remove_x (table
, obj
, scm_ihashv
, scm_sloppy_assv
, scm_delv_x
, 0);
303 SCM_DEFINE (scm_hash_get_handle
, "hash-get-handle", 2, 0, 0,
304 (SCM table
, SCM obj
),
305 "This procedure is similar to its @code{-ref} cousin, but returns a\n"
306 "@dfn{handle} from the hash table rather than the value associated with\n"
307 "@var{key}. By convention, a handle in a hash table is the pair which\n"
308 "associates a key with a value. Where @code{hash-ref table key} returns\n"
309 "only a @code{value}, @code{hash-get-handle table key} returns the pair\n"
310 "@code{(key . value)}.")
311 #define FUNC_NAME s_scm_hash_get_handle
313 return scm_hash_fn_get_handle (table
, obj
, scm_ihash
, scm_sloppy_assoc
, 0);
318 SCM_DEFINE (scm_hash_create_handle_x
, "hash-create-handle!", 3, 0, 0,
319 (SCM table
, SCM key
, SCM init
),
320 "This function looks up @var{key} in @var{table} and returns its handle.\n"
321 "If @var{key} is not already present, a new handle is created which\n"
322 "associates @var{key} with @var{init}.")
323 #define FUNC_NAME s_scm_hash_create_handle_x
325 return scm_hash_fn_create_handle_x (table
, key
, init
, scm_ihash
, scm_sloppy_assoc
, 0);
330 SCM_DEFINE (scm_hash_ref
, "hash-ref", 2, 1, 0,
331 (SCM table
, SCM obj
, SCM dflt
),
332 "Look up @var{key} in the hash table @var{table}, and return the\n"
333 "value (if any) associated with it. If @var{key} is not found,\n"
334 "return @var{default} (or @code{#f} if no @var{default} argument is\n"
335 "supplied). Uses `equal?' for equality testing.")
336 #define FUNC_NAME s_scm_hash_ref
338 if (SCM_UNBNDP (dflt
))
340 return scm_hash_fn_ref (table
, obj
, dflt
, scm_ihash
, scm_sloppy_assoc
, 0);
346 SCM_DEFINE (scm_hash_set_x
, "hash-set!", 3, 0, 0,
347 (SCM table
, SCM obj
, SCM val
),
348 "Find the entry in @var{table} associated with @var{key}, and store\n"
349 "@var{value} there. Uses `equal?' for equality testing.")
350 #define FUNC_NAME s_scm_hash_set_x
352 return scm_hash_fn_set_x (table
, obj
, val
, scm_ihash
, scm_sloppy_assoc
, 0);
358 SCM_DEFINE (scm_hash_remove_x
, "hash-remove!", 2, 0, 0,
359 (SCM table
, SCM obj
),
360 "Remove @var{key} (and any value associated with it) from @var{table}.\n"
361 "Uses `equal?' for equality tests.")
362 #define FUNC_NAME s_scm_hash_remove_x
364 return scm_hash_fn_remove_x (table
, obj
, scm_ihash
, scm_sloppy_assoc
, scm_delete_x
, 0);
371 struct scm_ihashx_closure
381 scm_ihashx (SCM obj
,unsigned int n
,struct scm_ihashx_closure
* closure
)
385 answer
= scm_apply (closure
->hash
,
386 scm_listify (obj
, scm_ulong2num ((unsigned long)n
), SCM_UNDEFINED
),
389 return SCM_INUM (answer
);
395 scm_sloppy_assx (SCM obj
,SCM alist
,struct scm_ihashx_closure
* closure
)
399 answer
= scm_apply (closure
->assoc
,
400 scm_listify (obj
, alist
, SCM_UNDEFINED
),
410 scm_delx_x (SCM obj
,SCM alist
,struct scm_ihashx_closure
* closure
)
414 answer
= scm_apply (closure
->delete,
415 scm_listify (obj
, alist
, SCM_UNDEFINED
),
423 SCM_DEFINE (scm_hashx_get_handle
, "hashx-get-handle", 4, 0, 0,
424 (SCM hash
, SCM assoc
, SCM table
, SCM obj
),
425 "This behaves the same way as the corresponding @code{-get-handle}\n"
426 "function, but uses @var{hasher} as a\n"
427 "hash function and @var{assoc} to compare keys. @code{hasher} must\n"
428 "be a function that takes two arguments, a key to be hashed and a\n"
429 "table size. @code{assoc} must be an associator function, like\n"
430 "@code{assoc}, @code{assq} or @code{assv}.")
431 #define FUNC_NAME s_scm_hashx_get_handle
433 struct scm_ihashx_closure closure
;
435 closure
.assoc
= assoc
;
436 return scm_hash_fn_get_handle (table
, obj
, scm_ihashx
, scm_sloppy_assx
, (void *)&closure
);
441 SCM_DEFINE (scm_hashx_create_handle_x
, "hashx-create-handle!", 5, 0, 0,
442 (SCM hash
,SCM assoc
,SCM table
,SCM obj
,SCM init
),
443 "This behaves the same way as the corresponding @code{-create-handle}\n"
444 "function, but uses @var{hasher} as a\n"
445 "hash function and @var{assoc} to compare keys. @code{hasher} must\n"
446 "be a function that takes two arguments, a key to be hashed and a\n"
447 "table size. @code{assoc} must be an associator function, like\n"
448 "@code{assoc}, @code{assq} or @code{assv}.")
449 #define FUNC_NAME s_scm_hashx_create_handle_x
451 struct scm_ihashx_closure closure
;
453 closure
.assoc
= assoc
;
454 return scm_hash_fn_create_handle_x (table
, obj
, init
, scm_ihashx
, scm_sloppy_assx
, (void *)&closure
);
460 SCM_DEFINE (scm_hashx_ref
, "hashx-ref", 4, 1, 0,
461 (SCM hash
,SCM assoc
,SCM table
,SCM obj
,SCM dflt
),
462 "This behaves the same way as the corresponding @code{ref}\n"
463 "function, but uses @var{hasher} as a\n"
464 "hash function and @var{assoc} to compare keys. @code{hasher} must\n"
465 "be a function that takes two arguments, a key to be hashed and a\n"
466 "table size. @code{assoc} must be an associator function, like\n"
467 "@code{assoc}, @code{assq} or @code{assv}.\n\n"
468 "By way of illustration, @code{hashq-ref table key} is equivalent\n"
469 "to @code{hashx-ref hashq assq table key}.")
470 #define FUNC_NAME s_scm_hashx_ref
472 struct scm_ihashx_closure closure
;
473 if (SCM_UNBNDP (dflt
))
476 closure
.assoc
= assoc
;
477 return scm_hash_fn_ref (table
, obj
, dflt
, scm_ihashx
, scm_sloppy_assx
, (void *)&closure
);
484 SCM_DEFINE (scm_hashx_set_x
, "hashx-set!", 5, 0, 0,
485 (SCM hash
, SCM assoc
, SCM table
, SCM obj
, SCM val
),
486 "This behaves the same way as the corresponding @code{set!}\n"
487 "function, but uses @var{hasher} as a\n"
488 "hash function and @var{assoc} to compare keys. @code{hasher} must\n"
489 "be a function that takes two arguments, a key to be hashed and a\n"
490 "table size. @code{assoc} must be an associator function, like\n"
491 "@code{assoc}, @code{assq} or @code{assv}.\n\n"
492 "By way of illustration, @code{hashq-set! table key} is equivalent\n"
493 "to @code{hashx-set! hashq assq table key}.")
494 #define FUNC_NAME s_scm_hashx_set_x
496 struct scm_ihashx_closure closure
;
498 closure
.assoc
= assoc
;
499 return scm_hash_fn_set_x (table
, obj
, val
, scm_ihashx
, scm_sloppy_assx
, (void *)&closure
);
506 scm_hashx_remove_x (SCM hash
,SCM assoc
,SCM
delete,SCM table
,SCM obj
)
508 struct scm_ihashx_closure closure
;
510 closure
.assoc
= assoc
;
511 closure
.delete = delete;
512 return scm_hash_fn_remove_x (table
, obj
, scm_ihashx
, scm_sloppy_assx
, scm_delx_x
, 0);
516 fold_proc (void *proc
, SCM key
, SCM data
, SCM value
)
518 return scm_apply (SCM_PACK (proc
), SCM_LIST3 (key
, data
, value
), SCM_EOL
);
521 SCM_DEFINE (scm_hash_fold
, "hash-fold", 3, 0, 0,
522 (SCM proc
, SCM init
, SCM table
),
523 "An iterator over hash-table elements.\n"
524 "Accumulates and returns a result by applying PROC successively.\n"
525 "The arguments to PROC are \"(key value prior-result)\" where key\n"
526 "and value are successive pairs from the hash table TABLE, and\n"
527 "prior-result is either INIT (for the first application of PROC)\n"
528 "or the return value of the previous application of PROC.\n"
529 "For example, @code{(hash-fold acons () tab)} will convert a hash\n"
530 "table into an a-list of key-value pairs.\n")
531 #define FUNC_NAME s_scm_hash_fold
533 SCM_VALIDATE_PROC (1,proc
);
534 SCM_VALIDATE_VECTOR (3,table
);
535 return scm_internal_hash_fold (fold_proc
, (void *) SCM_UNPACK (proc
), init
, table
);
540 scm_internal_hash_fold (SCM (*fn
) (), void *closure
, SCM init
, SCM table
)
542 int i
, n
= SCM_LENGTH (table
);
544 for (i
= 0; i
< n
; ++i
)
546 SCM ls
= SCM_VELTS (table
)[i
], handle
;
547 while (SCM_NNULLP (ls
))
549 SCM_ASSERT (SCM_CONSP (ls
),
550 table
, SCM_ARG1
, s_scm_hash_fold
);
551 handle
= SCM_CAR (ls
);
552 SCM_ASSERT (SCM_CONSP (handle
),
553 table
, SCM_ARG1
, s_scm_hash_fold
);
554 result
= fn (closure
, SCM_CAR (handle
), SCM_CDR (handle
), result
);
567 #include "libguile/hashtab.x"