Mercurial > hg > xemacs-beta
annotate src/hash.h @ 5566:4654c01af32b
Improve the implementation, documentation of #'labels, #'flet.
lisp/ChangeLog addition:
2011-09-07 Aidan Kehoe <kehoea@parhasard.net>
* bytecomp.el:
* bytecomp.el (for-effect): Move this earlier in the file, it's
referenced in byte-compile-initial-macro-environment.
* bytecomp.el (byte-compile-initial-macro-environment):
In the byte-compile-macro-environment definition for #'labels, put
off the compiling the lambda bodies until the point where the rest
of the form is being compiled, allowing the lambda bodies to
access appropriate values for byte-compile-bound-variables, and
reducing excessive warning about free variables.
Add a byte-compile-macro-environment definition for #'flet. This
modifies byte-compile-function-environment appropriately, and
warns about bindings of functions that have macro definitions in
the current environment, about functions that have byte codes, and
about functions that have byte-compile methods (which may not do
what the user wants at runtime).
* bytecomp.el (byte-compile-funcall):
If FUNCTION is constant, call #'byte-compile-callargs-warn if
that's appropriate, giving warnings about problems with calling
functions bound with #'labels.
* cl-macs.el:
* cl-macs.el (flet):
Mention the main difference from Common Lisp, that the bindings
are dynamic, not lexical. Counsel the use of #'labels, not #'flet,
for this and other reasons. Explain the limited single use case for
#'flet. Cross-reference to bytecomp.el in a comment.
* cl-macs.el (labels):
Go into detail on which functions may be called from
where. Explain how to access the function definition of a label
within FORM. Add a comment cross-referencing to bytecomp.el.
man/ChangeLog addition:
2011-09-07 Aidan Kehoe <kehoea@parhasard.net>
* cl.texi (Function Bindings):
Move #'labels first, describe it in more detail, explaining that
it is to be preferred over #'flet, and explaining why.
Explain that dynamic bindings with #'flet will also not work when
functions are accessed through their bytecodes.
author | Aidan Kehoe <kehoea@parhasard.net> |
---|---|
date | Wed, 07 Sep 2011 16:26:45 +0100 |
parents | 308d34e9f07d |
children | e2fae7783046 |
rev | line source |
---|---|
1292 | 1 /* Copyright (C) 2003 Ben Wing. |
2 This file is part of XEmacs. | |
428 | 3 |
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
2515
diff
changeset
|
4 XEmacs is free software: you can redistribute it and/or modify it |
428 | 5 under the terms of the GNU General Public License as published by the |
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
2515
diff
changeset
|
6 Free Software Foundation, either version 3 of the License, or (at your |
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
2515
diff
changeset
|
7 option) any later version. |
428 | 8 |
9 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
12 for more details. | |
13 | |
14 You should have received a copy of the GNU General Public License | |
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
2515
diff
changeset
|
15 along with XEmacs. If not, see <http://www.gnu.org/licenses/>. */ |
428 | 16 |
17 /* Synched up with: Not in FSF. */ | |
18 | |
440 | 19 #ifndef INCLUDED_hash_h_ |
20 #define INCLUDED_hash_h_ | |
428 | 21 |
22 typedef struct | |
23 { | |
442 | 24 const void *key; |
428 | 25 void *contents; |
26 } hentry; | |
27 | |
442 | 28 typedef int (*hash_table_test_function) (const void *, const void *); |
665 | 29 typedef Hashcode (*hash_table_hash_function) (const void *); |
428 | 30 |
31 struct hash_table | |
32 { | |
33 hentry *harray; | |
34 long zero_set; | |
35 void *zero_entry; | |
665 | 36 Elemcount size; /* size of the hasharray */ |
37 Elemcount fullness; /* number of entries in the hash table */ | |
428 | 38 hash_table_hash_function hash_function; |
39 hash_table_test_function test_function; | |
40 }; | |
41 | |
42 /* SIZE is the number of initial entries. The hash table will be grown | |
43 automatically if the number of entries approaches the size */ | |
665 | 44 struct hash_table *make_hash_table (Elemcount size); |
428 | 45 |
2515 | 46 struct hash_table *make_string_hash_table (Elemcount size); |
47 | |
826 | 48 struct hash_table *make_general_hash_table (Elemcount size, |
49 hash_table_hash_function | |
50 hash_function, | |
51 hash_table_test_function | |
52 test_function); | |
428 | 53 |
54 /* Clear HASH-TABLE. A freshly created hash table is already cleared up. */ | |
55 void clrhash (struct hash_table *hash_table); | |
56 | |
57 /* Free HASH-TABLE and its substructures */ | |
58 void free_hash_table (struct hash_table *hash_table); | |
59 | |
60 /* Returns a hentry whose key is 0 if the entry does not exist in HASH-TABLE */ | |
442 | 61 const void *gethash (const void *key, struct hash_table *hash_table, |
62 const void **ret_value); | |
428 | 63 |
64 /* KEY should be different from 0 */ | |
442 | 65 void puthash (const void *key, void *contents, struct hash_table *hash_table); |
428 | 66 |
67 /* delete the entry with key KEY */ | |
442 | 68 void remhash (const void *key, struct hash_table *hash_table); |
428 | 69 |
442 | 70 typedef int (*maphash_function) (const void* key, void* contents, void* arg); |
428 | 71 |
442 | 72 typedef int (*remhash_predicate) (const void* key, const void* contents, |
428 | 73 void* arg); |
74 | |
75 /* Call MF (key, contents, arg) for every entry in HASH-TABLE */ | |
76 void maphash (maphash_function mf, struct hash_table *hash_table, void* arg); | |
77 | |
78 /* Delete all objects from HASH-TABLE satisfying PREDICATE */ | |
79 void map_remhash (remhash_predicate predicate, | |
80 struct hash_table *hash_table, void *arg); | |
81 | |
1292 | 82 /* Grow the table if it has less than BREATHING_ROOM elements that can be |
83 added before a resize will be triggered. After the grow, the table can | |
84 hold at least BREATHING_ROOM elements (and probably a lot more) before | |
85 needing resizing again. */ | |
86 void pregrow_hash_table_if_necessary (struct hash_table *hash_table, | |
87 Elemcount breathing_room); | |
440 | 88 #endif /* INCLUDED_hash_h_ */ |