chiark / gitweb /
Change header file guard names.
[mLib] / sym.h
CommitLineData
0875b58f 1/* -*-c-*-
2 *
c6e0eaf0 3 * $Id: sym.h,v 1.10 1999/12/10 23:42:04 mdw Exp $
0875b58f 4 *
5 * Symbol table management
6 *
7 * (c) 1998 Straylight/Edgeware
8 */
9
c846879c 10/*----- Licensing notice --------------------------------------------------*
0875b58f 11 *
12 * This file is part of the mLib utilities library.
13 *
14 * mLib is free software; you can redistribute it and/or modify
c846879c 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.
18 *
0875b58f 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
c846879c 22 * GNU Library General Public License for more details.
23 *
24 * You should have received a copy of the GNU Library General Public
0bd98442 25 * License along with mLib; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
27 * MA 02111-1307, USA.
0875b58f 28 */
29
30/*----- Revision history --------------------------------------------------*
31 *
32 * $Log: sym.h,v $
c6e0eaf0 33 * Revision 1.10 1999/12/10 23:42:04 mdw
34 * Change header file guard names.
35 *
dc2feaa9 36 * Revision 1.9 1999/08/02 16:53:48 mdw
37 * Improve type safety for sym_iter objects.
38 *
03d53b73 39 * Revision 1.8 1999/08/02 14:45:48 mdw
40 * Break low-level hashtable code out from sym.
41 *
d4d7a053 42 * Revision 1.7 1999/06/01 09:49:33 mdw
43 * Allow things to be looked up by just their caller-supplied hashes. This
44 * actually needs to be thought through better.
45 *
34b97201 46 * Revision 1.6 1999/05/26 21:08:31 mdw
47 * Rename symbols in line with newer conventions.
48 *
8c6d948b 49 * Revision 1.5 1999/05/13 22:48:37 mdw
50 * Change `-ise' to `-ize' throughout.
51 *
0bd98442 52 * Revision 1.4 1999/05/06 19:51:35 mdw
53 * Reformatted the LGPL notice a little bit.
54 *
c846879c 55 * Revision 1.3 1999/05/05 18:50:31 mdw
56 * Change licensing conditions to LGPL.
57 *
a5d14ede 58 * Revision 1.2 1998/11/26 19:27:34 mdw
59 * Move SYM_NAME into the header file. Fix bugs.
60 *
61 * Revision 1.1.1.1 1998/06/17 23:44:42 mdw
62 * Initial version of mLib
0875b58f 63 *
64 */
65
c6e0eaf0 66#ifndef MLIB_SYM_H
67#define MLIB_SYM_H
0875b58f 68
69#ifdef __cplusplus
70 extern "C" {
71#endif
72
73/*----- Required headers --------------------------------------------------*/
74
75#include <stddef.h>
76
c6e0eaf0 77#ifndef MLIB_BITS_H
d4d7a053 78# include "bits.h"
79#endif
80
c6e0eaf0 81#ifndef MLIB_HASH_H
03d53b73 82# include "hash.h"
83#endif
84
0875b58f 85/*----- Type definitions --------------------------------------------------*/
86
87/* --- Symbol table --- *
88 *
89 * A @sym_table@ contains the information needed to manage a symbol table.
90 * Users shouldn't fiddle with this information directly, but it needs to be
91 * here so that objects of the correct type can be created.
92 */
93
94typedef struct sym_table {
03d53b73 95 hash_table t;
96 size_t load;
0875b58f 97} sym_table;
98
99/* --- A symbol table entry --- *
100 *
101 * I don't care what actually gets stored in symbol entries because I don't
102 * create them: that's the responsibility of my client. All I care about
103 * here is that whatever gets passed to me is a structure whose first member
104 * is a @sym_base@. The ANSI guarantees about structure layout are
105 * sufficient to allow me to manipulate such objects.
106 */
107
108#define SYM_BUFSZ 16 /* Size of local string buffer */
109
110typedef struct sym_base {
03d53b73 111 hash_base b;
0875b58f 112 union {
113 char *p; /* Pointer to name string */
114 char b[SYM_BUFSZ]; /* Buffer containing a short name */
115 } name; /* Name of this symbol */
116 size_t len; /* Length of the symbol's name */
117} sym_base;
118
a5d14ede 119/* --- A macro to pick a symbol's name out from the mess --- */
120
121#define SYM_NAME(sy) \
122 (((sym_base *)(sy))->len > SYM_BUFSZ ? \
123 ((sym_base *)(sy))->name.p : \
124 ((sym_base *)(sy))->name.b)
125
0875b58f 126/* --- An iterator block --- */
127
dc2feaa9 128typedef struct { hash_iter i; } sym_iter;
0875b58f 129
130/*----- External functions ------------------------------------------------*/
131
34b97201 132/* --- @sym_create@ --- *
0875b58f 133 *
8c6d948b 134 * Arguments: @sym_table *t@ = symbol table to initialize
0875b58f 135 *
136 * Returns: ---
137 *
8c6d948b 138 * Use: Initializes the given symbol table. Raises @EXC_NOMEM@ if
0875b58f 139 * there isn't enough memory.
140 */
141
34b97201 142extern void sym_create(sym_table */*t*/);
0875b58f 143
34b97201 144/* --- @sym_destroy@ --- *
0875b58f 145 *
146 * Arguments: @sym_table *t@ = pointer to symbol table in question
147 *
148 * Returns: ---
149 *
150 * Use: Destroys a symbol table, freeing all the memory it used to
151 * occupy.
152 */
153
34b97201 154extern void sym_destroy(sym_table */*t*/);
0875b58f 155
156/* --- @sym_find@ --- *
157 *
158 * Arguments: @sym_table *t@ = pointer to symbol table in question
159 * @const char *n@ = pointer to symbol table to look up
160 * @long l@ = length of the name string or negative to measure
161 * @size_t sz@ = size of desired symbol object, or zero
162 * @unsigned *f@ = pointer to a flag, or null.
163 *
164 * Returns: The address of a @sym_base@ structure, or null if not found
165 * and @sz@ is zero.
166 *
167 * Use: Looks up a symbol in a given symbol table. The name is
168 * passed by the address of its first character. The length
169 * may be given, in which case the name may contain arbitrary
170 * binary data, or it may be given as a negative number, in
171 * which case the length of the name is calculated as
03d53b73 172 * @strlen(n) + 1@.
0875b58f 173 *
174 * The return value is the address of a pointer to a @sym_base@
175 * block (which may have other things on the end, as above). If
176 * the symbol could be found, the return value points to the
177 * symbol block. If the symbol wasn't there, then if @sz@ is
178 * nonzero, a new symbol is created and its address is returned;
179 * otherwise a null pointer is returned. The exception
180 * @EXC_NOMEM@ is raised if the block can't be allocated.
181 *
182 * The value of @*f@ indicates whether a new symbol entry was
183 * created: a nonzero value indicates that an old value was
184 * found.
185 */
186
187extern void *sym_find(sym_table */*t*/, const char */*n*/, long /*l*/,
188 size_t /*sz*/, unsigned */*f*/);
189
190/* --- @sym_remove@ --- *
191 *
c6e0eaf0 192 * Arguments: @sym_table *t@ = pointer to a symbol table object
0875b58f 193 * @void *b@ = pointer to symbol table entry
194 *
195 * Returns: ---
196 *
197 * Use: Removes the object from the symbol table. The space occupied
198 * by the object and its name is freed; anything else attached
199 * to the entry should already be gone by this point.
200 */
201
202extern void sym_remove(sym_table */*t*/, void */*b*/);
203
34b97201 204/* --- @sym_mkiter@ --- *
0875b58f 205 *
206 * Arguments: @sym_iter *i@ = pointer to an iterator object
207 * @sym_table *t@ = pointer to a symbol table object
208 *
209 * Returns: ---
210 *
211 * Use: Creates a new symbol table iterator which may be used to
212 * iterate through a symbol table.
213 */
214
dc2feaa9 215#define SYM_MKITER(i_, t_) HASH_MKITER(&(i_)->i, &(t_)->t)
03d53b73 216
34b97201 217extern void sym_mkiter(sym_iter */*i*/, sym_table */*t*/);
0875b58f 218
219/* --- @sym_next@ --- *
220 *
221 * Arguments: @sym_iter *i@ = pointer to iterator object
222 *
223 * Returns: Pointer to the next symbol found, or null when finished.
224 *
225 * Use: Returns the next symbol from the table. Symbols are not
226 * returned in any particular order.
227 */
228
dc2feaa9 229#define SYM_NEXT(i_, p) do { \
03d53b73 230 hash_base *_q; \
dc2feaa9 231 HASH_NEXT(&(i_)->i, _q); \
03d53b73 232 (p) = (void *)_q; \
233} while (0)
234
0875b58f 235extern void *sym_next(sym_iter */*i*/);
236
237/*----- That's all, folks -------------------------------------------------*/
238
239#ifdef __cplusplus
240 }
241#endif
242
243#endif