|
0
|
1 /* Lisp interface to hash tables.
|
|
|
2 Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
|
|
|
3 Copyright (C) 1995, 1996 Ben Wing.
|
|
|
4
|
|
|
5 This file is part of XEmacs.
|
|
|
6
|
|
|
7 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
8 under the terms of the GNU General Public License as published by the
|
|
|
9 Free Software Foundation; either version 2, or (at your option) any
|
|
|
10 later version.
|
|
|
11
|
|
|
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
15 for more details.
|
|
|
16
|
|
|
17 You should have received a copy of the GNU General Public License
|
|
|
18 along with XEmacs; see the file COPYING. If not, write to
|
|
|
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
20 Boston, MA 02111-1307, USA. */
|
|
|
21
|
|
|
22 /* Synched up with: Not in FSF. */
|
|
|
23
|
|
|
24 #include <config.h>
|
|
|
25 #include "lisp.h"
|
|
|
26 #include "hash.h"
|
|
|
27 #include "elhash.h"
|
|
|
28 #include "bytecode.h"
|
|
|
29
|
|
|
30 Lisp_Object Qhashtablep;
|
|
|
31
|
|
|
32 #define LISP_OBJECTS_PER_HENTRY (sizeof (hentry) / sizeof (Lisp_Object))/* 2 */
|
|
|
33
|
|
|
34 struct hashtable_struct
|
|
|
35 {
|
|
|
36 struct lcrecord_header header;
|
|
|
37 unsigned int fullness;
|
|
|
38 unsigned long (*hash_function) (CONST void *);
|
|
|
39 int (*test_function) (CONST void *, CONST void *);
|
|
|
40 Lisp_Object zero_entry;
|
|
|
41 Lisp_Object harray;
|
|
|
42 enum hashtable_type type; /* whether and how this hashtable is weak */
|
|
|
43 Lisp_Object next_weak; /* Used to chain together all of the weak
|
|
|
44 hashtables. Don't mark through this. */
|
|
|
45 };
|
|
|
46
|
|
|
47 static Lisp_Object Vall_weak_hashtables;
|
|
|
48
|
|
|
49 static Lisp_Object mark_hashtable (Lisp_Object, void (*) (Lisp_Object));
|
|
|
50 static void print_hashtable (Lisp_Object, Lisp_Object, int);
|
|
|
51 DEFINE_LRECORD_IMPLEMENTATION ("hashtable", hashtable,
|
|
|
52 mark_hashtable, print_hashtable, 0, 0, 0,
|
|
|
53 struct hashtable_struct);
|
|
|
54
|
|
|
55 static Lisp_Object
|
|
|
56 mark_hashtable (Lisp_Object obj, void (*markobj) (Lisp_Object))
|
|
|
57 {
|
|
|
58 struct hashtable_struct *table = XHASHTABLE (obj);
|
|
|
59
|
|
|
60 if (table->type != HASHTABLE_NONWEAK)
|
|
|
61 {
|
|
|
62 /* If the table is weak, we don't want to mark the keys and values
|
|
|
63 (we scan over them after everything else has been marked,
|
|
|
64 and mark or remove them as necessary). Note that we will mark
|
|
|
65 the table->harray itself at the same time; it's hard to mark
|
|
|
66 that here without also marking its contents. */
|
|
|
67 return Qnil;
|
|
|
68 }
|
|
|
69 ((markobj) (table->zero_entry));
|
|
|
70 return (table->harray);
|
|
|
71 }
|
|
|
72
|
|
|
73 static void
|
|
|
74 print_hashtable (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
|
|
|
75 {
|
|
|
76 struct hashtable_struct *table = XHASHTABLE (obj);
|
|
|
77 char buf[200];
|
|
|
78 if (print_readably)
|
|
|
79 error ("printing unreadable object #<hashtable 0x%x>",
|
|
|
80 table->header.uid);
|
|
|
81 sprintf (buf, GETTEXT ("#<%shashtable %d/%ld 0x%x>"),
|
|
|
82 (table->type == HASHTABLE_WEAK ? "weak " :
|
|
|
83 table->type == HASHTABLE_KEY_WEAK ? "key-weak " :
|
|
|
84 table->type == HASHTABLE_VALUE_WEAK ? "value-weak " :
|
|
|
85 table->type == HASHTABLE_KEY_CAR_WEAK ? "key-car-weak " :
|
|
|
86 table->type == HASHTABLE_VALUE_CAR_WEAK ? "value-car-weak " :
|
|
|
87 ""),
|
|
|
88 table->fullness,
|
|
|
89 (vector_length (XVECTOR (table->harray)) / LISP_OBJECTS_PER_HENTRY),
|
|
|
90 table->header.uid);
|
|
|
91 write_c_string (buf, printcharfun);
|
|
|
92 }
|
|
|
93
|
|
|
94 static void
|
|
|
95 ht_copy_to_c (struct hashtable_struct *ht,
|
|
|
96 c_hashtable c_table)
|
|
|
97 {
|
|
|
98 int len;
|
|
|
99
|
|
|
100 c_table->harray = (void *) vector_data (XVECTOR (ht->harray));
|
|
|
101 c_table->zero_set = (!GC_UNBOUNDP (ht->zero_entry));
|
|
|
102 c_table->zero_entry = LISP_TO_VOID (ht->zero_entry);
|
|
|
103 len = vector_length (XVECTOR (ht->harray));
|
|
|
104 if (len < 0)
|
|
|
105 {
|
|
|
106 /* #### if alloc.c mark_object() changes, this must change too. */
|
|
|
107 /* barf gag retch. When a vector is marked, its len is
|
|
|
108 made less than 0. In the prune_weak_hashtables() stage,
|
|
|
109 we are called on vectors that are like this, and we must
|
|
|
110 be able to deal. */
|
|
|
111 assert (gc_in_progress);
|
|
|
112 len = -1 - len;
|
|
|
113 }
|
|
|
114 c_table->size = len/LISP_OBJECTS_PER_HENTRY;
|
|
|
115 c_table->fullness = ht->fullness;
|
|
|
116 c_table->hash_function = ht->hash_function;
|
|
|
117 c_table->test_function = ht->test_function;
|
|
|
118 XSETHASHTABLE (c_table->elisp_table, ht);
|
|
|
119 }
|
|
|
120
|
|
|
121 static void
|
|
|
122 ht_copy_from_c (c_hashtable c_table,
|
|
|
123 struct hashtable_struct *ht)
|
|
|
124 {
|
|
|
125 struct Lisp_Vector dummy;
|
|
|
126 /* C is truly hateful */
|
|
|
127 void *vec_addr
|
|
|
128 = ((char *) c_table->harray
|
|
|
129 - ((char *) &(dummy.contents) - (char *) &dummy));
|
|
|
130
|
|
|
131 XSETVECTOR (ht->harray, vec_addr);
|
|
|
132 if (c_table->zero_set)
|
|
|
133 VOID_TO_LISP (ht->zero_entry, c_table->zero_entry);
|
|
|
134 else
|
|
|
135 ht->zero_entry = Qunbound;
|
|
|
136 ht->fullness = c_table->fullness;
|
|
|
137 }
|
|
|
138
|
|
|
139
|
|
|
140 static struct hashtable_struct *
|
|
|
141 allocate_hashtable (void)
|
|
|
142 {
|
|
|
143 struct hashtable_struct *table
|
|
|
144 = alloc_lcrecord (sizeof (struct hashtable_struct), lrecord_hashtable);
|
|
|
145 table->harray = Qnil;
|
|
|
146 table->zero_entry = Qunbound;
|
|
|
147 table->fullness = 0;
|
|
|
148 table->hash_function = 0;
|
|
|
149 table->test_function = 0;
|
|
|
150 return (table);
|
|
|
151 }
|
|
|
152
|
|
|
153 char *
|
|
|
154 elisp_hvector_malloc (unsigned int bytes, Lisp_Object table)
|
|
|
155 {
|
|
|
156 Lisp_Object new_vector;
|
|
|
157 struct hashtable_struct *ht;
|
|
|
158
|
|
|
159 ht = XHASHTABLE (table);
|
|
|
160 assert (bytes > vector_length (XVECTOR (ht->harray)) * sizeof (Lisp_Object));
|
|
|
161 new_vector = make_vector ((bytes / sizeof (Lisp_Object)), Qzero);
|
|
|
162 return ((char *) (vector_data (XVECTOR (new_vector))));
|
|
|
163 }
|
|
|
164
|
|
|
165 void
|
|
|
166 elisp_hvector_free (void *ptr, Lisp_Object table)
|
|
|
167 {
|
|
|
168 struct hashtable_struct *ht = XHASHTABLE (table);
|
|
|
169 #if defined (USE_ASSERTIONS) || defined (DEBUG_XEMACS)
|
|
|
170 Lisp_Object current_vector = ht->harray;
|
|
|
171 #endif
|
|
|
172
|
|
|
173 assert (((void *) vector_data (XVECTOR (current_vector))) == ptr);
|
|
|
174 ht->harray = Qnil; /* Let GC do its job */
|
|
|
175 return;
|
|
|
176 }
|
|
|
177
|
|
|
178
|
|
|
179 DEFUN ("hashtablep", Fhashtablep, Shashtablep, 1, 1, 0 /*
|
|
|
180 Return t if OBJ is a hashtable, else nil.
|
|
|
181 */ )
|
|
|
182 (obj)
|
|
|
183 Lisp_Object obj;
|
|
|
184 {
|
|
|
185 return ((HASHTABLEP (obj)) ? Qt : Qnil);
|
|
|
186 }
|
|
|
187
|
|
|
188
|
|
|
189
|
|
|
190
|
|
|
191 #if 0 /* I don't think these are needed any more.
|
|
|
192 If using the general lisp_object_equal_*() functions
|
|
|
193 causes efficiency problems, these can be resurrected. --ben */
|
|
|
194 /* equality and hash functions for Lisp strings */
|
|
|
195 int
|
|
|
196 lisp_string_equal (CONST void *x1, CONST void *x2)
|
|
|
197 {
|
|
|
198 Lisp_Object str1, str2;
|
|
|
199 CVOID_TO_LISP (str1, x1);
|
|
|
200 CVOID_TO_LISP (str2, x2);
|
|
|
201 return !strcmp ((char *) string_data (XSTRING (str1)),
|
|
|
202 (char *) string_data (XSTRING (str2)));
|
|
|
203 }
|
|
|
204
|
|
|
205 unsigned long
|
|
|
206 lisp_string_hash (CONST void *x)
|
|
|
207 {
|
|
|
208 Lisp_Object str;
|
|
|
209 CVOID_TO_LISP (str, x);
|
|
|
210 return hash_string (string_data (XSTRING (str)),
|
|
|
211 string_length (XSTRING (str)));
|
|
|
212 }
|
|
|
213
|
|
|
214 #endif /* 0 */
|
|
|
215
|
|
|
216 static int
|
|
|
217 lisp_object_eql_equal (CONST void *x1, CONST void *x2)
|
|
|
218 {
|
|
|
219 Lisp_Object obj1, obj2;
|
|
|
220 CVOID_TO_LISP (obj1, x1);
|
|
|
221 CVOID_TO_LISP (obj2, x2);
|
|
|
222 return
|
|
|
223 (FLOATP (obj1) ? !NILP (Fequal (obj1, obj2)) : EQ (obj1, obj2));
|
|
|
224 }
|
|
|
225
|
|
|
226 static unsigned long
|
|
|
227 lisp_object_eql_hash (CONST void *x)
|
|
|
228 {
|
|
|
229 Lisp_Object obj;
|
|
|
230 CVOID_TO_LISP (obj, x);
|
|
|
231 if (FLOATP (obj))
|
|
|
232 return internal_hash (obj, 0);
|
|
|
233 else
|
|
|
234 return LISP_HASH (obj);
|
|
|
235 }
|
|
|
236
|
|
|
237 static int
|
|
|
238 lisp_object_equal_equal (CONST void *x1, CONST void *x2)
|
|
|
239 {
|
|
|
240 Lisp_Object obj1, obj2;
|
|
|
241 CVOID_TO_LISP (obj1, x1);
|
|
|
242 CVOID_TO_LISP (obj2, x2);
|
|
|
243 return !NILP (Fequal (obj1, obj2));
|
|
|
244 }
|
|
|
245
|
|
|
246 static unsigned long
|
|
|
247 lisp_object_equal_hash (CONST void *x)
|
|
|
248 {
|
|
|
249 Lisp_Object obj;
|
|
|
250 CVOID_TO_LISP (obj, x);
|
|
|
251 return internal_hash (obj, 0);
|
|
|
252 }
|
|
|
253
|
|
|
254 Lisp_Object
|
|
|
255 make_lisp_hashtable (int size,
|
|
|
256 enum hashtable_type type,
|
|
|
257 enum hashtable_test_fun test)
|
|
|
258 {
|
|
|
259 Lisp_Object result;
|
|
|
260 struct hashtable_struct *table = allocate_hashtable ();
|
|
|
261
|
|
|
262 table->harray = make_vector ((compute_harray_size (size)
|
|
|
263 * LISP_OBJECTS_PER_HENTRY),
|
|
|
264 Qzero);
|
|
|
265 switch (test)
|
|
|
266 {
|
|
|
267 case HASHTABLE_EQ:
|
|
|
268 table->test_function = 0;
|
|
|
269 table->hash_function = 0;
|
|
|
270 break;
|
|
|
271
|
|
|
272 case HASHTABLE_EQL:
|
|
|
273 table->test_function = lisp_object_eql_equal;
|
|
|
274 table->hash_function = lisp_object_eql_hash;
|
|
|
275 break;
|
|
|
276
|
|
|
277 case HASHTABLE_EQUAL:
|
|
|
278 table->test_function = lisp_object_equal_equal;
|
|
|
279 table->hash_function = lisp_object_equal_hash;
|
|
|
280 break;
|
|
|
281
|
|
|
282 default:
|
|
|
283 abort ();
|
|
|
284 }
|
|
|
285
|
|
|
286 table->type = type;
|
|
|
287 XSETHASHTABLE (result, table);
|
|
|
288
|
|
|
289 if (table->type != HASHTABLE_NONWEAK)
|
|
|
290 {
|
|
|
291 table->next_weak = Vall_weak_hashtables;
|
|
|
292 Vall_weak_hashtables = result;
|
|
|
293 }
|
|
|
294 else
|
|
|
295 table->next_weak = Qunbound;
|
|
|
296
|
|
|
297 return (result);
|
|
|
298 }
|
|
|
299
|
|
|
300 static enum hashtable_test_fun
|
|
|
301 decode_hashtable_test_fun (Lisp_Object sym)
|
|
|
302 {
|
|
|
303 if (NILP (sym))
|
|
|
304 return HASHTABLE_EQL;
|
|
|
305
|
|
|
306 CHECK_SYMBOL (sym);
|
|
|
307
|
|
2
|
308 if (EQ (sym, Qeq)) return HASHTABLE_EQ;
|
|
|
309 if (EQ (sym, Qequal)) return HASHTABLE_EQUAL;
|
|
|
310 if (EQ (sym, Qeql)) return HASHTABLE_EQL;
|
|
|
311
|
|
0
|
312 signal_simple_error ("Invalid hashtable test fun", sym);
|
|
2
|
313 return HASHTABLE_EQ; /* not reached */
|
|
0
|
314 }
|
|
|
315
|
|
|
316 DEFUN ("make-hashtable", Fmake_hashtable, Smake_hashtable, 1, 2, 0 /*
|
|
|
317 Make a hashtable of initial size SIZE.
|
|
|
318 Comparison between keys is done with TEST-FUN, which must be one of
|
|
|
319 `eq', `eql', or `equal'. The default is `eql'; i.e. two keys must
|
|
|
320 be the same object (or have the same floating-point value, for floats)
|
|
|
321 to be considered equivalent.
|
|
|
322
|
|
|
323 See also `make-weak-hashtable', `make-key-weak-hashtable', and
|
|
|
324 `make-value-weak-hashtable'.
|
|
|
325 */ )
|
|
|
326 (size, test_fun)
|
|
|
327 Lisp_Object size, test_fun;
|
|
|
328 {
|
|
|
329 CHECK_NATNUM (size);
|
|
|
330 return make_lisp_hashtable (XINT (size), HASHTABLE_NONWEAK,
|
|
|
331 decode_hashtable_test_fun (test_fun));
|
|
|
332 }
|
|
|
333
|
|
|
334 DEFUN ("copy-hashtable", Fcopy_hashtable, Scopy_hashtable, 1, 1, 0 /*
|
|
|
335 Make a new hashtable which contains the same keys and values
|
|
|
336 as the given table. The keys and values will not themselves be copied.
|
|
|
337 */ )
|
|
|
338 (old_table)
|
|
|
339 Lisp_Object old_table;
|
|
|
340 {
|
|
|
341 struct _C_hashtable old_htbl;
|
|
|
342 struct _C_hashtable new_htbl;
|
|
|
343 struct hashtable_struct *old_ht;
|
|
|
344 struct hashtable_struct *new_ht;
|
|
|
345 Lisp_Object result;
|
|
|
346
|
|
|
347 CHECK_HASHTABLE (old_table);
|
|
|
348 old_ht = XHASHTABLE (old_table);
|
|
|
349 ht_copy_to_c (old_ht, &old_htbl);
|
|
|
350
|
|
|
351 /* we can't just call Fmake_hashtable() here because that will make a
|
|
|
352 table that is slightly larger than the one we're trying to copy,
|
|
|
353 which will make copy_hash() blow up. */
|
|
|
354 new_ht = allocate_hashtable ();
|
|
|
355 new_ht->fullness = 0;
|
|
|
356 new_ht->zero_entry = Qunbound;
|
|
|
357 new_ht->hash_function = old_ht->hash_function;
|
|
|
358 new_ht->test_function = old_ht->test_function;
|
|
|
359 new_ht->harray = Fmake_vector (Flength (old_ht->harray), Qzero);
|
|
|
360 ht_copy_to_c (new_ht, &new_htbl);
|
|
|
361 copy_hash (&new_htbl, &old_htbl);
|
|
|
362 ht_copy_from_c (&new_htbl, new_ht);
|
|
|
363 new_ht->type = old_ht->type;
|
|
|
364 XSETHASHTABLE (result, new_ht);
|
|
|
365
|
|
|
366 if (UNBOUNDP (old_ht->next_weak))
|
|
|
367 new_ht->next_weak = Qunbound;
|
|
|
368 else
|
|
|
369 {
|
|
|
370 new_ht->next_weak = Vall_weak_hashtables;
|
|
|
371 Vall_weak_hashtables = result;
|
|
|
372 }
|
|
|
373
|
|
|
374 return (result);
|
|
|
375 }
|
|
|
376
|
|
|
377
|
|
|
378 DEFUN ("gethash", Fgethash, Sgethash, 2, 3, 0 /*
|
|
|
379 Find hash value for KEY in TABLE.
|
|
|
380 If there is no corresponding value, return DEFAULT (defaults to nil).
|
|
|
381 */ )
|
|
|
382 (key, table, defalt)
|
|
|
383 Lisp_Object key, table, defalt; /* One can't even spell correctly in C */
|
|
|
384 {
|
|
|
385 CONST void *vval;
|
|
|
386 struct _C_hashtable htbl;
|
|
|
387 if (!gc_in_progress)
|
|
|
388 CHECK_HASHTABLE (table);
|
|
|
389 ht_copy_to_c (XHASHTABLE (table), &htbl);
|
|
|
390 if (gethash (LISP_TO_VOID (key), &htbl, &vval))
|
|
|
391 {
|
|
|
392 Lisp_Object val;
|
|
|
393 CVOID_TO_LISP (val, vval);
|
|
|
394 return val;
|
|
|
395 }
|
|
|
396 else
|
|
|
397 return defalt;
|
|
|
398 }
|
|
|
399
|
|
|
400
|
|
|
401 DEFUN ("remhash", Fremhash, Sremhash, 2, 2, 0 /*
|
|
|
402 Remove hash value for KEY in TABLE.
|
|
|
403 */ )
|
|
|
404 (key, table)
|
|
|
405 Lisp_Object key, table;
|
|
|
406 {
|
|
|
407 struct _C_hashtable htbl;
|
|
|
408 CHECK_HASHTABLE (table);
|
|
|
409
|
|
|
410 ht_copy_to_c (XHASHTABLE (table), &htbl);
|
|
|
411 remhash (LISP_TO_VOID (key), &htbl);
|
|
|
412 ht_copy_from_c (&htbl, XHASHTABLE (table));
|
|
|
413 return Qnil;
|
|
|
414 }
|
|
|
415
|
|
|
416
|
|
|
417 DEFUN ("puthash", Fputhash, Sputhash, 3, 3, 0 /*
|
|
|
418 Hash KEY to VAL in TABLE.
|
|
|
419 */ )
|
|
|
420 (key, val, table)
|
|
|
421 Lisp_Object key, val, table;
|
|
|
422 {
|
|
|
423 struct hashtable_struct *ht;
|
|
|
424 void *vkey = LISP_TO_VOID (key);
|
|
|
425
|
|
|
426 CHECK_HASHTABLE (table);
|
|
|
427 ht = XHASHTABLE (table);
|
|
|
428 if (!vkey)
|
|
|
429 ht->zero_entry = val;
|
|
|
430 else
|
|
|
431 {
|
|
|
432 struct gcpro gcpro1, gcpro2, gcpro3;
|
|
|
433 struct _C_hashtable htbl;
|
|
|
434
|
|
|
435 ht_copy_to_c (XHASHTABLE (table), &htbl);
|
|
|
436 GCPRO3 (key, val, table);
|
|
|
437 puthash (vkey, LISP_TO_VOID (val), &htbl);
|
|
|
438 ht_copy_from_c (&htbl, XHASHTABLE (table));
|
|
|
439 UNGCPRO;
|
|
|
440 }
|
|
|
441 return (val);
|
|
|
442 }
|
|
|
443
|
|
|
444 DEFUN ("clrhash", Fclrhash, Sclrhash, 1, 1, 0 /*
|
|
|
445 Flush TABLE.
|
|
|
446 */ )
|
|
|
447 (table)
|
|
|
448 Lisp_Object table;
|
|
|
449 {
|
|
|
450 struct _C_hashtable htbl;
|
|
|
451 CHECK_HASHTABLE (table);
|
|
|
452 ht_copy_to_c (XHASHTABLE (table), &htbl);
|
|
|
453 clrhash (&htbl);
|
|
|
454 ht_copy_from_c (&htbl, XHASHTABLE (table));
|
|
|
455 return Qnil;
|
|
|
456 }
|
|
|
457
|
|
|
458 DEFUN ("hashtable-fullness", Fhashtable_fullness, Shashtable_fullness, 1, 1, 0 /*
|
|
|
459 Return number of entries in TABLE.
|
|
|
460 */ )
|
|
|
461 (table)
|
|
|
462 Lisp_Object table;
|
|
|
463 {
|
|
|
464 struct _C_hashtable htbl;
|
|
|
465 CHECK_HASHTABLE (table);
|
|
|
466 ht_copy_to_c (XHASHTABLE (table), &htbl);
|
|
|
467 return (make_int (htbl.fullness));
|
|
|
468 }
|
|
|
469
|
|
|
470
|
|
|
471 static void
|
|
|
472 verify_function (Lisp_Object function, CONST char *description)
|
|
|
473 {
|
|
|
474 if (SYMBOLP (function))
|
|
|
475 {
|
|
|
476 if (NILP (function))
|
|
|
477 return;
|
|
|
478 else
|
|
|
479 function = indirect_function (function, 1);
|
|
|
480 }
|
|
|
481 if (SUBRP (function) || COMPILED_FUNCTIONP (function))
|
|
|
482 return;
|
|
|
483 else if (CONSP (function))
|
|
|
484 {
|
|
|
485 Lisp_Object funcar = Fcar (function);
|
|
|
486 if ((SYMBOLP (funcar))
|
|
|
487 && (EQ (funcar, Qlambda)
|
|
|
488 #ifdef MOCKLISP_SUPPORT
|
|
|
489 || EQ (funcar, Qmocklisp)
|
|
|
490 #endif
|
|
|
491 || EQ (funcar, Qautoload)))
|
|
|
492 return;
|
|
|
493 }
|
|
|
494 signal_error (Qinvalid_function, list1 (function));
|
|
|
495 }
|
|
|
496
|
|
|
497 static void
|
|
|
498 lisp_maphash_function (CONST void *void_key,
|
|
|
499 void *void_val,
|
|
|
500 void *void_fn)
|
|
|
501 {
|
|
|
502 /* This function can GC */
|
|
|
503 Lisp_Object key, val, fn;
|
|
|
504 CVOID_TO_LISP (key, void_key);
|
|
|
505 VOID_TO_LISP (val, void_val);
|
|
|
506 VOID_TO_LISP (fn, void_fn);
|
|
|
507 call2 (fn, key, val);
|
|
|
508 }
|
|
|
509
|
|
|
510
|
|
|
511 DEFUN ("maphash", Fmaphash, Smaphash, 2, 2, 0 /*
|
|
|
512 Map FUNCTION over entries in TABLE, calling it with two args,
|
|
|
513 each key and value in the table.
|
|
|
514 */ )
|
|
|
515 (function, table)
|
|
|
516 Lisp_Object function, table;
|
|
|
517 {
|
|
|
518 struct _C_hashtable htbl;
|
|
|
519 struct gcpro gcpro1, gcpro2;
|
|
|
520
|
|
|
521 verify_function (function, GETTEXT ("hashtable mapping function"));
|
|
|
522 CHECK_HASHTABLE (table);
|
|
|
523 ht_copy_to_c (XHASHTABLE (table), &htbl);
|
|
|
524 GCPRO2 (table, function);
|
|
|
525 maphash (lisp_maphash_function, &htbl, LISP_TO_VOID (function));
|
|
|
526 UNGCPRO;
|
|
|
527 return Qnil;
|
|
|
528 }
|
|
|
529
|
|
|
530
|
|
|
531 /* This function is for mapping a *C* function over the elements of a
|
|
|
532 lisp hashtable.
|
|
|
533 */
|
|
|
534 void
|
|
|
535 elisp_maphash (maphash_function function, Lisp_Object table, void *closure)
|
|
|
536 {
|
|
|
537 struct _C_hashtable htbl;
|
|
|
538
|
|
|
539 if (!gc_in_progress) CHECK_HASHTABLE (table);
|
|
|
540 ht_copy_to_c (XHASHTABLE (table), &htbl);
|
|
|
541 maphash (function, &htbl, closure);
|
|
|
542 }
|
|
|
543
|
|
|
544 void
|
|
|
545 elisp_map_remhash (remhash_predicate function,
|
|
|
546 Lisp_Object table,
|
|
|
547 void *closure)
|
|
|
548 {
|
|
|
549 struct _C_hashtable htbl;
|
|
|
550
|
|
|
551 if (!gc_in_progress) CHECK_HASHTABLE (table);
|
|
|
552 ht_copy_to_c (XHASHTABLE (table), &htbl);
|
|
|
553 map_remhash (function, &htbl, closure);
|
|
|
554 ht_copy_from_c (&htbl, XHASHTABLE (table));
|
|
|
555 }
|
|
|
556
|
|
|
557 #if 0
|
|
|
558 void
|
|
|
559 elisp_table_op (Lisp_Object table, generic_hashtable_op op, void *arg1,
|
|
|
560 void *arg2, void *arg3)
|
|
|
561 {
|
|
|
562 struct _C_hashtable htbl;
|
|
|
563 CHECK_HASHTABLE (table);
|
|
|
564 ht_copy_to_c (XHASHTABLE (table), &htbl);
|
|
|
565 (*op) (&htbl, arg1, arg2, arg3);
|
|
|
566 ht_copy_from_c (&htbl, XHASHTABLE (table));
|
|
|
567 }
|
|
|
568 #endif /* 0 */
|
|
|
569
|
|
|
570
|
|
|
571
|
|
|
572 DEFUN ("make-weak-hashtable", Fmake_weak_hashtable, Smake_weak_hashtable,
|
|
|
573 1, 2, 0 /*
|
|
|
574 Make a fully weak hashtable of initial size SIZE.
|
|
|
575 A weak hashtable is one whose pointers do not count as GC referents:
|
|
|
576 for any key-value pair in the hashtable, if the only remaining pointer
|
|
|
577 to either the key or the value is in a weak hash table, then the pair
|
|
|
578 will be removed from the table, and the key and value collected. A
|
|
|
579 non-weak hash table (or any other pointer) would prevent the object
|
|
|
580 from being collected.
|
|
|
581
|
|
|
582 You can also create semi-weak hashtables; see `make-key-weak-hashtable'
|
|
|
583 and `make-value-weak-hashtable'.
|
|
|
584 */ )
|
|
|
585 (size, test_fun)
|
|
|
586 Lisp_Object size, test_fun;
|
|
|
587 {
|
|
|
588 CHECK_NATNUM (size);
|
|
|
589 return make_lisp_hashtable (XINT (size), HASHTABLE_WEAK,
|
|
|
590 decode_hashtable_test_fun (test_fun));
|
|
|
591 }
|
|
|
592
|
|
|
593 DEFUN ("make-key-weak-hashtable", Fmake_key_weak_hashtable,
|
|
|
594 Smake_key_weak_hashtable, 1, 2, 0 /*
|
|
|
595 Make a key-weak hashtable of initial size SIZE.
|
|
|
596 A key-weak hashtable is similar to a fully-weak hashtable (see
|
|
|
597 `make-weak-hashtable') except that a key-value pair will be removed
|
|
|
598 only if the key remains unmarked outside of weak hashtables. The pair
|
|
|
599 will remain in the hashtable if the key is pointed to by something other
|
|
|
600 than a weak hashtable, even if the value is not.
|
|
|
601 */ )
|
|
|
602 (size, test_fun)
|
|
|
603 Lisp_Object size, test_fun;
|
|
|
604 {
|
|
|
605 CHECK_NATNUM (size);
|
|
|
606 return make_lisp_hashtable (XINT (size), HASHTABLE_KEY_WEAK,
|
|
|
607 decode_hashtable_test_fun (test_fun));
|
|
|
608 }
|
|
|
609
|
|
|
610 DEFUN ("make-value-weak-hashtable", Fmake_value_weak_hashtable,
|
|
|
611 Smake_value_weak_hashtable, 1, 2, 0 /*
|
|
|
612 Make a value-weak hashtable of initial size SIZE.
|
|
|
613 A value-weak hashtable is similar to a fully-weak hashtable (see
|
|
|
614 `make-weak-hashtable') except that a key-value pair will be removed only
|
|
|
615 if the value remains unmarked outside of weak hashtables. The pair will
|
|
|
616 remain in the hashtable if the value is pointed to by something other
|
|
|
617 than a weak hashtable, even if the key is not.
|
|
|
618 */ )
|
|
|
619 (size, test_fun)
|
|
|
620 Lisp_Object size, test_fun;
|
|
|
621 {
|
|
|
622 CHECK_NATNUM (size);
|
|
|
623 return make_lisp_hashtable (XINT (size), HASHTABLE_VALUE_WEAK,
|
|
|
624 decode_hashtable_test_fun (test_fun));
|
|
|
625 }
|
|
|
626
|
|
|
627 struct marking_closure
|
|
|
628 {
|
|
|
629 int (*obj_marked_p) (Lisp_Object);
|
|
|
630 void (*markobj) (Lisp_Object);
|
|
|
631 enum hashtable_type type;
|
|
|
632 int did_mark;
|
|
|
633 };
|
|
|
634
|
|
|
635 static void
|
|
|
636 marking_mapper (CONST void *key, void *contents, void *closure)
|
|
|
637 {
|
|
|
638 Lisp_Object keytem, valuetem;
|
|
|
639 struct marking_closure *fmh =
|
|
|
640 (struct marking_closure *) closure;
|
|
|
641
|
|
|
642 /* This function is called over each pair in the hashtable.
|
|
|
643 We complete the marking for semi-weak hashtables. */
|
|
|
644 CVOID_TO_LISP (keytem, key);
|
|
|
645 CVOID_TO_LISP (valuetem, contents);
|
|
|
646
|
|
|
647 switch (fmh->type)
|
|
|
648 {
|
|
|
649 case HASHTABLE_KEY_WEAK:
|
|
|
650 if ((fmh->obj_marked_p) (keytem) &&
|
|
|
651 !(fmh->obj_marked_p) (valuetem))
|
|
|
652 {
|
|
|
653 (fmh->markobj) (valuetem);
|
|
|
654 fmh->did_mark = 1;
|
|
|
655 }
|
|
|
656 break;
|
|
|
657
|
|
|
658 case HASHTABLE_VALUE_WEAK:
|
|
|
659 if ((fmh->obj_marked_p) (valuetem) &&
|
|
|
660 !(fmh->obj_marked_p) (keytem))
|
|
|
661 {
|
|
|
662 (fmh->markobj) (keytem);
|
|
|
663 fmh->did_mark = 1;
|
|
|
664 }
|
|
|
665 break;
|
|
|
666
|
|
|
667 case HASHTABLE_KEY_CAR_WEAK:
|
|
|
668 if (!CONSP (keytem) || (fmh->obj_marked_p) (XCAR (keytem)))
|
|
|
669 {
|
|
|
670 if (!(fmh->obj_marked_p) (keytem))
|
|
|
671 {
|
|
|
672 (fmh->markobj) (keytem);
|
|
|
673 fmh->did_mark = 1;
|
|
|
674 }
|
|
|
675 if (!(fmh->obj_marked_p) (valuetem))
|
|
|
676 {
|
|
|
677 (fmh->markobj) (valuetem);
|
|
|
678 fmh->did_mark = 1;
|
|
|
679 }
|
|
|
680 }
|
|
|
681 break;
|
|
|
682
|
|
|
683 case HASHTABLE_VALUE_CAR_WEAK:
|
|
|
684 if (!CONSP (valuetem) || (fmh->obj_marked_p) (XCAR (valuetem)))
|
|
|
685 {
|
|
|
686 if (!(fmh->obj_marked_p) (keytem))
|
|
|
687 {
|
|
|
688 (fmh->markobj) (keytem);
|
|
|
689 fmh->did_mark = 1;
|
|
|
690 }
|
|
|
691 if (!(fmh->obj_marked_p) (valuetem))
|
|
|
692 {
|
|
|
693 (fmh->markobj) (valuetem);
|
|
|
694 fmh->did_mark = 1;
|
|
|
695 }
|
|
|
696 }
|
|
|
697 break;
|
|
|
698
|
|
|
699 default:
|
|
|
700 abort (); /* Huh? */
|
|
|
701 }
|
|
|
702
|
|
|
703 return;
|
|
|
704 }
|
|
|
705
|
|
|
706 int
|
|
|
707 finish_marking_weak_hashtables (int (*obj_marked_p) (Lisp_Object),
|
|
|
708 void (*markobj) (Lisp_Object))
|
|
|
709 {
|
|
|
710 Lisp_Object rest;
|
|
|
711 int did_mark = 0;
|
|
|
712
|
|
|
713 for (rest = Vall_weak_hashtables;
|
|
|
714 !GC_NILP (rest);
|
|
|
715 rest = XHASHTABLE (rest)->next_weak)
|
|
|
716 {
|
|
|
717 enum hashtable_type type;
|
|
|
718
|
|
|
719 if (! ((*obj_marked_p) (rest)))
|
|
|
720 /* The hashtable is probably garbage. Ignore it. */
|
|
|
721 continue;
|
|
|
722 type = XHASHTABLE (rest)->type;
|
|
|
723 if (type == HASHTABLE_KEY_WEAK || type == HASHTABLE_VALUE_WEAK
|
|
|
724 || type == HASHTABLE_KEY_CAR_WEAK
|
|
|
725 || type == HASHTABLE_VALUE_CAR_WEAK)
|
|
|
726 {
|
|
|
727 struct marking_closure fmh;
|
|
|
728
|
|
|
729 fmh.obj_marked_p = obj_marked_p;
|
|
|
730 fmh.markobj = markobj;
|
|
|
731 fmh.type = type;
|
|
|
732 fmh.did_mark = 0;
|
|
|
733 /* Now, scan over all the pairs. For all pairs that are
|
|
|
734 half-marked, we may need to mark the other half if we're
|
|
|
735 keeping this pair. */
|
|
|
736 elisp_maphash (marking_mapper, rest, &fmh);
|
|
|
737 if (fmh.did_mark)
|
|
|
738 did_mark = 1;
|
|
|
739 }
|
|
|
740
|
|
|
741 /* #### If alloc.c mark_object changes, this must change also... */
|
|
|
742 {
|
|
|
743 /* Now mark the vector itself. (We don't need to call markobj
|
|
|
744 here because we know that everything *in* it is already marked,
|
|
|
745 we just need to prevent the vector itself from disappearing.)
|
|
|
746 (The remhash above has taken care of zero_entry.)
|
|
|
747 */
|
|
|
748 struct Lisp_Vector *ptr = XVECTOR (XHASHTABLE (rest)->harray);
|
|
|
749 int len = vector_length (ptr);
|
|
|
750 if (len >= 0)
|
|
|
751 {
|
|
|
752 ptr->size = -1 - len;
|
|
|
753 did_mark = 1;
|
|
|
754 }
|
|
|
755 /* else it's already marked (remember, this function is iterated
|
|
|
756 until marking stops) */
|
|
|
757 }
|
|
|
758 }
|
|
|
759
|
|
|
760 return did_mark;
|
|
|
761 }
|
|
|
762
|
|
|
763 struct pruning_closure
|
|
|
764 {
|
|
|
765 int (*obj_marked_p) (Lisp_Object);
|
|
|
766 };
|
|
|
767
|
|
|
768 static int
|
|
|
769 pruning_mapper (CONST void *key, CONST void *contents, void *closure)
|
|
|
770 {
|
|
|
771 Lisp_Object keytem, valuetem;
|
|
|
772 struct pruning_closure *fmh =
|
|
|
773 (struct pruning_closure *) closure;
|
|
|
774
|
|
|
775 /* This function is called over each pair in the hashtable.
|
|
|
776 We remove the pairs that aren't completely marked (everything
|
|
|
777 that is going to stay ought to have been marked already
|
|
|
778 by the finish_marking stage). */
|
|
|
779 CVOID_TO_LISP (keytem, key);
|
|
|
780 CVOID_TO_LISP (valuetem, contents);
|
|
|
781
|
|
|
782 return (! ((*fmh->obj_marked_p) (keytem) &&
|
|
|
783 (*fmh->obj_marked_p) (valuetem)));
|
|
|
784 }
|
|
|
785
|
|
|
786 void
|
|
|
787 prune_weak_hashtables (int (*obj_marked_p) (Lisp_Object))
|
|
|
788 {
|
|
|
789 Lisp_Object rest, prev = Qnil;
|
|
|
790 for (rest = Vall_weak_hashtables;
|
|
|
791 !GC_NILP (rest);
|
|
|
792 rest = XHASHTABLE (rest)->next_weak)
|
|
|
793 {
|
|
|
794 if (! ((*obj_marked_p) (rest)))
|
|
|
795 {
|
|
|
796 /* This table itself is garbage. Remove it from the list. */
|
|
|
797 if (GC_NILP (prev))
|
|
|
798 Vall_weak_hashtables = XHASHTABLE (rest)->next_weak;
|
|
|
799 else
|
|
|
800 XHASHTABLE (prev)->next_weak = XHASHTABLE (rest)->next_weak;
|
|
|
801 }
|
|
|
802 else
|
|
|
803 {
|
|
|
804 struct pruning_closure fmh;
|
|
|
805 fmh.obj_marked_p = obj_marked_p;
|
|
|
806 /* Now, scan over all the pairs. Remove all of the pairs
|
|
|
807 in which the key or value, or both, is unmarked
|
|
|
808 (depending on the type of weak hashtable). */
|
|
|
809 elisp_map_remhash (pruning_mapper, rest, &fmh);
|
|
|
810 prev = rest;
|
|
|
811 }
|
|
|
812 }
|
|
|
813 }
|
|
|
814
|
|
|
815 /* Return a hash value for an array of Lisp_Objects of size SIZE. */
|
|
|
816
|
|
|
817 unsigned long
|
|
|
818 internal_array_hash (Lisp_Object *arr, int size, int depth)
|
|
|
819 {
|
|
|
820 int i;
|
|
|
821 unsigned long hash = 0;
|
|
|
822
|
|
|
823 if (size <= 5)
|
|
|
824 {
|
|
|
825 for (i = 0; i < size; i++)
|
|
|
826 hash = HASH2 (hash, internal_hash (arr[i], depth + 1));
|
|
|
827 return hash;
|
|
|
828 }
|
|
|
829
|
|
|
830 /* just pick five elements scattered throughout the array.
|
|
|
831 A slightly better approach would be to offset by some
|
|
|
832 noise factor from the points chosen below. */
|
|
|
833 for (i = 0; i < 5; i++)
|
|
|
834 hash = HASH2 (hash, internal_hash (arr[i*size/5], depth + 1));
|
|
|
835
|
|
|
836 return hash;
|
|
|
837 }
|
|
|
838
|
|
|
839 /* Return a hash value for a Lisp_Object. This is for use when hashing
|
|
|
840 objects with the comparison being `equal' (for `eq', you can just
|
|
|
841 use the Lisp_Object itself as the hash value). You need to make a
|
|
|
842 tradeoff between the speed of the hash function and how good the
|
|
|
843 hashing is. In particular, the hash function needs to be FAST,
|
|
|
844 so you can't just traipse down the whole tree hashing everything
|
|
|
845 together. Most of the time, objects will differ in the first
|
|
|
846 few elements you hash. Thus, we only go to a short depth (5)
|
|
|
847 and only hash at most 5 elements out of a vector. Theoretically
|
|
|
848 we could still take 5^5 time (a big big number) to compute a
|
|
|
849 hash, but practically this won't ever happen. */
|
|
|
850
|
|
|
851 unsigned long
|
|
|
852 internal_hash (Lisp_Object obj, int depth)
|
|
|
853 {
|
|
|
854 if (depth > 5)
|
|
|
855 return 0;
|
|
|
856 if (CONSP (obj))
|
|
|
857 {
|
|
|
858 /* no point in worrying about tail recursion, since we're not
|
|
|
859 going very deep */
|
|
|
860 return HASH2 (internal_hash (XCAR (obj), depth + 1),
|
|
|
861 internal_hash (XCDR (obj), depth + 1));
|
|
|
862 }
|
|
|
863 else if (STRINGP (obj))
|
|
|
864 return hash_string (string_data (XSTRING (obj)),
|
|
|
865 string_length (XSTRING (obj)));
|
|
|
866 #ifndef LRECORD_VECTOR
|
|
|
867 else if (VECTORP (obj))
|
|
|
868 {
|
|
|
869 struct Lisp_Vector *v = XVECTOR (obj);
|
|
|
870 return HASH2 (vector_length (v),
|
|
|
871 internal_array_hash (v->contents, vector_length (v),
|
|
|
872 depth + 1));
|
|
|
873 }
|
|
|
874 #endif /* !LRECORD_VECTOR */
|
|
|
875 else if (LRECORDP (obj))
|
|
|
876 {
|
|
|
877 CONST struct lrecord_implementation
|
|
|
878 *imp = XRECORD_LHEADER (obj)->implementation;
|
|
|
879 if (imp->hash)
|
|
|
880 return ((imp->hash) (obj, depth));
|
|
|
881 }
|
|
|
882
|
|
|
883 return LISP_HASH (obj);
|
|
|
884 }
|
|
|
885
|
|
|
886
|
|
|
887 /************************************************************************/
|
|
|
888 /* initialization */
|
|
|
889 /************************************************************************/
|
|
|
890
|
|
|
891 void
|
|
|
892 syms_of_elhash (void)
|
|
|
893 {
|
|
|
894 defsubr (&Smake_hashtable);
|
|
|
895 defsubr (&Scopy_hashtable);
|
|
|
896 defsubr (&Shashtablep);
|
|
|
897 defsubr (&Sgethash);
|
|
|
898 defsubr (&Sputhash);
|
|
|
899 defsubr (&Sremhash);
|
|
|
900 defsubr (&Sclrhash);
|
|
|
901 defsubr (&Smaphash);
|
|
|
902 defsubr (&Shashtable_fullness);
|
|
|
903 defsubr (&Smake_weak_hashtable);
|
|
|
904 defsubr (&Smake_key_weak_hashtable);
|
|
|
905 defsubr (&Smake_value_weak_hashtable);
|
|
|
906 defsymbol (&Qhashtablep, "hashtablep");
|
|
|
907 }
|
|
|
908
|
|
|
909 void
|
|
|
910 vars_of_elhash (void)
|
|
|
911 {
|
|
2
|
912 /* This must NOT be staticpro'd */
|
|
0
|
913 Vall_weak_hashtables = Qnil;
|
|
|
914 }
|
