Commit | Line | Data |
---|---|---|
0f2d19dd JB |
1 | /* classes: h_files */ |
2 | ||
0527e687 DH |
3 | #ifndef SCM_HASHTAB_H |
4 | #define SCM_HASHTAB_H | |
5 | ||
d587c9e8 | 6 | /* Copyright (C) 1995,1996,1999,2000,2001, 2003, 2004, 2006, 2008, 2009 Free Software Foundation, Inc. |
0527e687 | 7 | * |
73be1d9e | 8 | * This library is free software; you can redistribute it and/or |
53befeb7 NJ |
9 | * modify it under the terms of the GNU Lesser General Public License |
10 | * as published by the Free Software Foundation; either version 3 of | |
11 | * the License, or (at your option) any later version. | |
0527e687 | 12 | * |
53befeb7 NJ |
13 | * This library is distributed in the hope that it will be useful, but |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
73be1d9e MV |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
16 | * Lesser General Public License for more details. | |
0527e687 | 17 | * |
73be1d9e MV |
18 | * You should have received a copy of the GNU Lesser General Public |
19 | * License along with this library; if not, write to the Free Software | |
53befeb7 NJ |
20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
21 | * 02110-1301 USA | |
73be1d9e | 22 | */ |
0527e687 | 23 | |
0f2d19dd | 24 | \f |
0527e687 | 25 | |
5e044c02 | 26 | #include "libguile/__scm.h" |
0f2d19dd | 27 | |
c35738c1 MD |
28 | #include "weaks.h" |
29 | ||
30 | \f | |
31 | ||
32 | #define SCM_HASHTABLEF_WEAK_CAR SCM_WVECTF_WEAK_KEY | |
33 | #define SCM_HASHTABLEF_WEAK_CDR SCM_WVECTF_WEAK_VALUE | |
34 | ||
ecc9f40f | 35 | SCM_API scm_t_bits scm_tc16_hashtable; |
cdc5f676 | 36 | |
f5710d53 | 37 | #define SCM_HASHTABLE_P(x) SCM_SMOB_PREDICATE (scm_tc16_hashtable, x) |
c35738c1 MD |
38 | #define SCM_VALIDATE_HASHTABLE(pos, arg) \ |
39 | SCM_MAKE_VALIDATE_MSG (pos, arg, HASHTABLE_P, "hash-table") | |
f5710d53 MV |
40 | #define SCM_HASHTABLE_VECTOR(h) SCM_SMOB_OBJECT (h) |
41 | #define SCM_SET_HASHTABLE_VECTOR(x, v) SCM_SET_SMOB_OBJECT ((x), (v)) | |
42 | #define SCM_HASHTABLE(x) ((scm_t_hashtable *) SCM_SMOB_DATA_2 (x)) | |
c35738c1 MD |
43 | #define SCM_HASHTABLE_FLAGS(x) (SCM_HASHTABLE (x)->flags) |
44 | #define SCM_HASHTABLE_WEAK_KEY_P(x) \ | |
45 | (SCM_HASHTABLE_FLAGS (x) & SCM_HASHTABLEF_WEAK_CAR) | |
46 | #define SCM_HASHTABLE_WEAK_VALUE_P(x) \ | |
47 | (SCM_HASHTABLE_FLAGS (x) & SCM_HASHTABLEF_WEAK_CDR) | |
48 | #define SCM_HASHTABLE_DOUBLY_WEAK_P(x) \ | |
49 | ((SCM_HASHTABLE_FLAGS (x) \ | |
50 | & (SCM_HASHTABLEF_WEAK_CAR | SCM_HASHTABLEF_WEAK_CDR)) \ | |
51 | == (SCM_HASHTABLEF_WEAK_CAR | SCM_HASHTABLEF_WEAK_CDR)) | |
52 | #define SCM_HASHTABLE_WEAK_P(x) SCM_HASHTABLE_FLAGS (x) | |
53 | #define SCM_HASHTABLE_N_ITEMS(x) (SCM_HASHTABLE (x)->n_items) | |
54 | #define SCM_SET_HASHTABLE_N_ITEMS(x, n) (SCM_HASHTABLE (x)->n_items = n) | |
55 | #define SCM_HASHTABLE_INCREMENT(x) (SCM_HASHTABLE_N_ITEMS(x)++) | |
56 | #define SCM_HASHTABLE_DECREMENT(x) (SCM_HASHTABLE_N_ITEMS(x)--) | |
57 | #define SCM_HASHTABLE_UPPER(x) (SCM_HASHTABLE (x)->upper) | |
58 | #define SCM_HASHTABLE_LOWER(x) (SCM_HASHTABLE (x)->lower) | |
59 | ||
60 | #define SCM_HASHTABLE_N_BUCKETS(h) \ | |
3ebc1832 MV |
61 | SCM_SIMPLE_VECTOR_LENGTH (SCM_HASHTABLE_VECTOR (h)) |
62 | #define SCM_HASHTABLE_BUCKET(h, i) \ | |
63 | SCM_SIMPLE_VECTOR_REF (SCM_HASHTABLE_VECTOR (h), i) | |
c35738c1 | 64 | #define SCM_SET_HASHTABLE_BUCKET(h, i, x) \ |
3ebc1832 | 65 | SCM_SIMPLE_VECTOR_SET (SCM_HASHTABLE_VECTOR (h), i, x) |
c35738c1 | 66 | |
d587c9e8 LC |
67 | /* Function that computes a hash of OBJ modulo MAX. */ |
68 | typedef unsigned long (*scm_t_hash_fn) (SCM obj, unsigned long max, | |
69 | void *closure); | |
70 | ||
71 | /* Function that returns the value associated with OBJ in ALIST according to | |
72 | some equality predicate. */ | |
73 | typedef SCM (*scm_t_assoc_fn) (SCM obj, SCM alist, void *closure); | |
74 | ||
c35738c1 MD |
75 | typedef struct scm_t_hashtable { |
76 | int flags; /* properties of table */ | |
77 | unsigned long n_items; /* number of items in table */ | |
78 | unsigned long lower; /* when to shrink */ | |
79 | unsigned long upper; /* when to grow */ | |
80 | int size_index; /* index into hashtable_size */ | |
81 | int min_size_index; /* minimum size_index */ | |
d587c9e8 | 82 | scm_t_hash_fn hash_fn; /* for rehashing after a GC. */ |
c35738c1 MD |
83 | } scm_t_hashtable; |
84 | ||
0f2d19dd | 85 | \f |
0f2d19dd | 86 | |
1cc91f1b | 87 | #if 0 |
92c2555f MV |
88 | typedef unsigned int scm_t_hash_fn (SCM obj, unsigned int d, void *closure); |
89 | typedef SCM scm_t_assoc_fn (SCM key, SCM alist, void *closure); | |
90 | typedef SCM scm_t_delete_fn (SCM elt, SCM list); | |
1cc91f1b | 91 | #endif |
0f2d19dd | 92 | |
f59a096e | 93 | SCM_API SCM scm_vector_to_hash_table (SCM vector); |
33b001fd | 94 | SCM_API SCM scm_c_make_hash_table (unsigned long k); |
f59a096e | 95 | SCM_API SCM scm_make_hash_table (SCM n); |
c35738c1 MD |
96 | SCM_API SCM scm_make_weak_key_hash_table (SCM k); |
97 | SCM_API SCM scm_make_weak_value_hash_table (SCM k); | |
98 | SCM_API SCM scm_make_doubly_weak_hash_table (SCM k); | |
99 | ||
100 | SCM_API SCM scm_hash_table_p (SCM h); | |
101 | SCM_API SCM scm_weak_key_hash_table_p (SCM h); | |
102 | SCM_API SCM scm_weak_value_hash_table_p (SCM h); | |
103 | SCM_API SCM scm_doubly_weak_hash_table_p (SCM h); | |
104 | ||
d587c9e8 | 105 | SCM_INTERNAL void scm_i_rehash (SCM table, scm_t_hash_fn hash_fn, |
102dbb6f | 106 | void *closure, const char *func_name); |
00ffa0e7 | 107 | |
d587c9e8 LC |
108 | |
109 | SCM_API SCM scm_hash_fn_get_handle (SCM table, SCM obj, | |
110 | scm_t_hash_fn hash_fn, | |
111 | scm_t_assoc_fn assoc_fn, | |
112 | void *closure); | |
113 | SCM_API SCM scm_hash_fn_create_handle_x (SCM table, SCM obj, SCM init, | |
114 | scm_t_hash_fn hash_fn, | |
115 | scm_t_assoc_fn assoc_fn, | |
116 | void *closure); | |
117 | SCM_API SCM scm_hash_fn_ref (SCM table, SCM obj, SCM dflt, | |
118 | scm_t_hash_fn hash_fn, | |
119 | scm_t_assoc_fn assoc_fn, | |
120 | void *closure); | |
121 | SCM_API SCM scm_hash_fn_set_x (SCM table, SCM obj, SCM val, | |
122 | scm_t_hash_fn hash_fn, | |
123 | scm_t_assoc_fn assoc_fn, | |
124 | void *closure); | |
125 | SCM_API SCM scm_hash_fn_remove_x (SCM table, SCM obj, | |
126 | scm_t_hash_fn hash_fn, | |
127 | scm_t_assoc_fn assoc_fn, | |
128 | void *closure); | |
33b001fd | 129 | SCM_API SCM scm_internal_hash_fold (SCM (*fn) (), void *closure, SCM init, SCM table); |
711a9fd7 | 130 | SCM_API void scm_internal_hash_for_each_handle (SCM (*fn) (), void *closure, SCM table); |
c35738c1 | 131 | SCM_API SCM scm_hash_clear_x (SCM table); |
0f2d19dd | 132 | |
33b001fd MV |
133 | SCM_API SCM scm_hashq_get_handle (SCM table, SCM obj); |
134 | SCM_API SCM scm_hashq_create_handle_x (SCM table, SCM obj, SCM init); | |
135 | SCM_API SCM scm_hashq_ref (SCM table, SCM obj, SCM dflt); | |
136 | SCM_API SCM scm_hashq_set_x (SCM table, SCM obj, SCM val); | |
137 | SCM_API SCM scm_hashq_remove_x (SCM table, SCM obj); | |
138 | SCM_API SCM scm_hashv_get_handle (SCM table, SCM obj); | |
139 | SCM_API SCM scm_hashv_create_handle_x (SCM table, SCM obj, SCM init); | |
140 | SCM_API SCM scm_hashv_ref (SCM table, SCM obj, SCM dflt); | |
141 | SCM_API SCM scm_hashv_set_x (SCM table, SCM obj, SCM val); | |
142 | SCM_API SCM scm_hashv_remove_x (SCM table, SCM obj); | |
143 | SCM_API SCM scm_hash_get_handle (SCM table, SCM obj); | |
144 | SCM_API SCM scm_hash_create_handle_x (SCM table, SCM obj, SCM init); | |
145 | SCM_API SCM scm_hash_ref (SCM table, SCM obj, SCM dflt); | |
146 | SCM_API SCM scm_hash_set_x (SCM table, SCM obj, SCM val); | |
147 | SCM_API SCM scm_hash_remove_x (SCM table, SCM obj); | |
148 | SCM_API SCM scm_hashx_get_handle (SCM hash, SCM assoc, SCM table, SCM obj); | |
149 | SCM_API SCM scm_hashx_create_handle_x (SCM hash, SCM assoc, SCM table, SCM obj, SCM init); | |
150 | SCM_API SCM scm_hashx_ref (SCM hash, SCM assoc, SCM table, SCM obj, SCM dflt); | |
151 | SCM_API SCM scm_hashx_set_x (SCM hash, SCM assoc, SCM table, SCM obj, SCM val); | |
a9cf5c71 | 152 | SCM_API SCM scm_hashx_remove_x (SCM hash, SCM assoc, SCM table, SCM obj); |
33b001fd | 153 | SCM_API SCM scm_hash_fold (SCM proc, SCM init, SCM hash); |
c35738c1 | 154 | SCM_API SCM scm_hash_for_each (SCM proc, SCM hash); |
711a9fd7 MD |
155 | SCM_API SCM scm_hash_for_each_handle (SCM proc, SCM hash); |
156 | SCM_API SCM scm_hash_map_to_list (SCM proc, SCM hash); | |
102dbb6f LC |
157 | SCM_INTERNAL void scm_hashtab_prehistory (void); |
158 | SCM_INTERNAL void scm_init_hashtab (void); | |
0f2d19dd | 159 | |
0527e687 | 160 | #endif /* SCM_HASHTAB_H */ |
89e00824 ML |
161 | |
162 | /* | |
163 | Local Variables: | |
164 | c-file-style: "gnu" | |
165 | End: | |
166 | */ |