3 * $Id: sym.c,v 1.13 2001/01/25 21:14:49 mdw Exp $
5 * Symbol table management
7 * (c) 1998 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the mLib utilities library.
14 * mLib is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * mLib is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with mLib; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.13 2001/01/25 21:14:49 mdw
34 * Always add a terminating null, and don't count it in the length.
36 * Revision 1.12 2001/01/20 11:49:37 mdw
37 * Export tuning parameters from header file, for the benefit of other
38 * hashtable implementations. Change the storage of symbol names: store
39 * the name after the allocated symbol block in all cases. This replaces
40 * the previous complicated and slightly wasteful arrangement.
42 * Revision 1.11 2000/06/17 10:37:39 mdw
43 * Add support for arena management.
45 * Revision 1.10 1999/12/10 23:42:04 mdw
46 * Change header file guard names.
48 * Revision 1.9 1999/10/22 22:36:37 mdw
49 * New test structure for symbol tables.
51 * Revision 1.8 1999/08/02 14:45:48 mdw
52 * Break low-level hashtable code out from sym.
54 * Revision 1.7 1999/06/01 09:49:08 mdw
55 * Allow things to be looked up by just their caller-supplied hashes. This
56 * actually needs to be thought through better.
58 * Revision 1.6 1999/05/26 21:08:31 mdw
59 * Rename symbols in line with newer conventions.
61 * Revision 1.5 1999/05/13 22:48:37 mdw
62 * Twiddle the extension threshold. Change `-ise' to `-ize' throughout.
64 * Revision 1.4 1999/05/06 19:51:35 mdw
65 * Reformatted the LGPL notice a little bit.
67 * Revision 1.3 1999/05/05 18:50:31 mdw
68 * Change licensing conditions to LGPL.
70 * Revision 1.2 1998/11/26 19:27:33 mdw
71 * Move SYM_NAME into the header file. Fix bugs.
73 * Revision 1.1.1.1 1998/06/17 23:44:42 mdw
74 * Initial version of mLib
78 /*----- Header files ------------------------------------------------------*/
80 /* --- ANSI headers --- */
86 /* --- Local headers --- */
97 /*----- Main code ---------------------------------------------------------*/
99 /* --- @sym_create@ --- *
101 * Arguments: @sym_table *t@ = symbol table to initialize
105 * Use: Initializes the given symbol table. Raises @EXC_NOMEM@ if
106 * there isn't enough memory.
109 void sym_create(sym_table *t)
111 hash_create(&t->t, SYM_INITSZ);
113 t->load = SYM_LIMIT(SYM_INITSZ);
116 /* --- @sym_destroy@ --- *
118 * Arguments: @sym_table *t@ = pointer to symbol table in question
122 * Use: Destroys a symbol table, freeing all the memory it used to
126 void sym_destroy(sym_table *t)
141 /* --- @sym_find@ --- *
143 * Arguments: @sym_table *t@ = pointer to symbol table in question
144 * @const char *n@ = pointer to symbol table to look up
145 * @long l@ = length of the name string or negative to measure
146 * @size_t sz@ = size of desired symbol object, or zero
147 * @unsigned *f@ = pointer to a flag, or null.
149 * Returns: The address of a @sym_base@ structure, or null if not found
152 * Use: Looks up a symbol in a given symbol table. The name is
153 * passed by the address of its first character. The length
154 * may be given, in which case the name may contain arbitrary
155 * binary data, or it may be given as a negative number, in
156 * which case the length of the name is calculated as
159 * The return value is the address of a pointer to a @sym_base@
160 * block (which may have other things on the end, as above). If
161 * the symbol could be found, the return value points to the
162 * symbol block. If the symbol wasn't there, then if @sz@ is
163 * nonzero, a new symbol is created and its address is returned;
164 * otherwise a null pointer is returned. The exception
165 * @EXC_NOMEM@ is raised if the block can't be allocated.
167 * The value of @*f@ indicates whether a new symbol entry was
168 * created: a nonzero value indicates that an old value was
172 void *sym_find(sym_table *t, const char *n, long l, size_t sz, unsigned *f)
176 hash_base **bin, **p;
179 /* --- Find the correct bin --- */
181 len = l < 0 ? strlen(n) : l;
182 CRC32(hash, 0, n, len);
183 bin = HASH_BIN(&t->t, hash);
185 /* --- Search the bin list --- */
187 for (p = bin; *p; p = &(*p)->next) {
189 if (hash == q->b.hash && len == q->len && !memcmp(n, SYM_NAME(q), len)) {
191 /* --- Found a match --- *
193 * As a minor, and probably pointless, tweak, move the item to the
194 * front of its bin list.
201 /* --- Return the block --- */
208 /* --- Couldn't find the item there --- */
213 /* --- Create a new symbol block and initialize it --- *
215 * The name is attached to the end of the symbol block.
218 q = x_alloc(t->t.a, sz + len + 1);
221 q->name = (char *)q + sz;
222 memcpy(q->name, n, len);
227 /* --- Consider growing the array --- */
231 if (!t->load && hash_extend(&t->t))
232 t->load = SYM_LIMIT(t->t.mask + 1);
234 /* --- Finished that, so return the new symbol block --- */
239 /* --- @sym_remove@ --- *
241 * Arguments: @sym_table *t@ = pointer to a symbol table object
242 * @void *p@ = pointer to symbol table entry
246 * Use: Removes the object from the symbol table. The space occupied
247 * by the object and its name is freed; anything else attached
248 * to the entry should already be gone by this point.
251 void sym_remove(sym_table *t, void *p)
254 hash_remove(&t->t, &q->b);
259 /* --- @sym_mkiter@ --- *
261 * Arguments: @sym_iter *i@ = pointer to an iterator object
262 * @sym_table *t@ = pointer to a symbol table object
266 * Use: Creates a new symbol table iterator which may be used to
267 * iterate through a symbol table.
270 void sym_mkiter(sym_iter *i, sym_table *t) { SYM_MKITER(i, t); }
272 /* --- @sym_next@ --- *
274 * Arguments: @sym_iter *i@ = pointer to iterator object
276 * Returns: Pointer to the next symbol found, or null when finished.
278 * Use: Returns the next symbol from the table. Symbols are not
279 * returned in any particular order.
282 void *sym_next(sym_iter *i)
289 /*----- That's all, folks -------------------------------------------------*/