X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/mLib/blobdiff_plain/c846879ccf3e86ea293c157f4aa2ff8716fb5b4c..c6e0eaf00cd09a4e5237e70d8351049ec91d7653:/sym.h

diff --git a/sym.h b/sym.h
index 5c87b4a..7dd9217 100644
--- a/sym.h
+++ b/sym.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: sym.h,v 1.3 1999/05/05 18:50:31 mdw Exp $
+ * $Id: sym.h,v 1.10 1999/12/10 23:42:04 mdw Exp $
  *
  * Symbol table management
  *
@@ -22,13 +22,36 @@
  * GNU Library General Public License for more details.
  * 
  * You should have received a copy of the GNU Library General Public
- * License along with mLib; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * License along with mLib; if not, write to the Free
+ * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ * MA 02111-1307, USA.
  */
 
 /*----- Revision history --------------------------------------------------*
  *
  * $Log: sym.h,v $
+ * Revision 1.10  1999/12/10 23:42:04  mdw
+ * Change header file guard names.
+ *
+ * Revision 1.9  1999/08/02 16:53:48  mdw
+ * Improve type safety for sym_iter objects.
+ *
+ * Revision 1.8  1999/08/02 14:45:48  mdw
+ * Break low-level hashtable code out from sym.
+ *
+ * Revision 1.7  1999/06/01 09:49:33  mdw
+ * Allow things to be looked up by just their caller-supplied hashes.  This
+ * actually needs to be thought through better.
+ *
+ * Revision 1.6  1999/05/26 21:08:31  mdw
+ * Rename symbols in line with newer conventions.
+ *
+ * Revision 1.5  1999/05/13 22:48:37  mdw
+ * Change `-ise' to `-ize' throughout.
+ *
+ * Revision 1.4  1999/05/06 19:51:35  mdw
+ * Reformatted the LGPL notice a little bit.
+ *
  * Revision 1.3  1999/05/05 18:50:31  mdw
  * Change licensing conditions to LGPL.
  *
@@ -40,8 +63,8 @@
  *
  */
 
-#ifndef SYM_H
-#define SYM_H
+#ifndef MLIB_SYM_H
+#define MLIB_SYM_H
 
 #ifdef __cplusplus
   extern "C" {
@@ -51,6 +74,14 @@
 
 #include <stddef.h>
 
+#ifndef MLIB_BITS_H
+#  include "bits.h"
+#endif
+
+#ifndef MLIB_HASH_H
+#  include "hash.h"
+#endif
+
 /*----- Type definitions --------------------------------------------------*/
 
 /* --- Symbol table --- *
@@ -61,9 +92,8 @@
  */
 
 typedef struct sym_table {
-  unsigned long mask;			/* Bit mask for hashing purposes */
-  size_t c;				/* Down counter for growing table */
-  struct sym_base **a;			/* Array of hash bins */
+  hash_table t;
+  size_t load;
 } sym_table;
 
 /* --- A symbol table entry --- *
@@ -78,8 +108,7 @@ typedef struct sym_table {
 #define SYM_BUFSZ 16			/* Size of local string buffer */
 
 typedef struct sym_base {
-  struct sym_base *next;		/* Next symbol in hash bin */
-  unsigned long hash;			/* Hash value for symbol's name */
+  hash_base b;
   union {
     char *p;				/* Pointer to name string */
     char b[SYM_BUFSZ];			/* Buffer containing a short name */
@@ -96,27 +125,23 @@ typedef struct sym_base {
 
 /* --- An iterator block --- */
 
-typedef struct sym_iter {
-  sym_table *t;				/* Symbol table being iterated */
-  sym_base *n;				/* Address of next item to return */
-  size_t i;				/* Index of next hash bin to use */
-} sym_iter;
+typedef struct { hash_iter i; } sym_iter;
 
 /*----- External functions ------------------------------------------------*/
 
-/* --- @sym_createTable@ --- *
+/* --- @sym_create@ --- *
  *
- * Arguments:	@sym_table *t@ = symbol table to initialise
+ * Arguments:	@sym_table *t@ = symbol table to initialize
  *
  * Returns:	---
  *
- * Use:		Initialises the given symbol table.  Raises @EXC_NOMEM@ if
+ * Use:		Initializes the given symbol table.  Raises @EXC_NOMEM@ if
  *		there isn't enough memory.
  */
 
-extern void sym_createTable(sym_table */*t*/);
+extern void sym_create(sym_table */*t*/);
 
-/* --- @sym_destroyTable@ --- *
+/* --- @sym_destroy@ --- *
  *
  * Arguments:	@sym_table *t@ = pointer to symbol table in question
  *
@@ -126,7 +151,7 @@ extern void sym_createTable(sym_table */*t*/);
  *		occupy.
  */
 
-extern void sym_destroyTable(sym_table */*t*/);
+extern void sym_destroy(sym_table */*t*/);
 
 /* --- @sym_find@ --- *
  *
@@ -144,7 +169,7 @@ extern void sym_destroyTable(sym_table */*t*/);
  *		may be given, in which case the name may contain arbitrary
  *		binary data, or it may be given as a negative number, in
  *		which case the length of the name is calculated as
- *		@strlen(n)@.
+ *		@strlen(n) + 1@.
  *
  *		The return value is the address of a pointer to a @sym_base@
  *		block (which may have other things on the end, as above).  If
@@ -164,7 +189,7 @@ extern void *sym_find(sym_table */*t*/, const char */*n*/, long /*l*/,
 
 /* --- @sym_remove@ --- *
  *
- * Arguments:	@sym_table *i@ = pointer to a symbol table object
+ * Arguments:	@sym_table *t@ = pointer to a symbol table object
  *		@void *b@ = pointer to symbol table entry
  *
  * Returns:	---
@@ -176,7 +201,7 @@ extern void *sym_find(sym_table */*t*/, const char */*n*/, long /*l*/,
 
 extern void sym_remove(sym_table */*t*/, void */*b*/);
 
-/* --- @sym_createIter@ --- *
+/* --- @sym_mkiter@ --- *
  *
  * Arguments:	@sym_iter *i@ = pointer to an iterator object
  *		@sym_table *t@ = pointer to a symbol table object
@@ -187,7 +212,9 @@ extern void sym_remove(sym_table */*t*/, void */*b*/);
  *		iterate through a symbol table.
  */
 
-extern void sym_createIter(sym_iter */*i*/, sym_table */*t*/);
+#define SYM_MKITER(i_, t_) HASH_MKITER(&(i_)->i, &(t_)->t)
+
+extern void sym_mkiter(sym_iter */*i*/, sym_table */*t*/);
 
 /* --- @sym_next@ --- *
  *
@@ -199,6 +226,12 @@ extern void sym_createIter(sym_iter */*i*/, sym_table */*t*/);
  *		returned in any particular order.
  */
 
+#define SYM_NEXT(i_, p) do {						\
+  hash_base *_q;							\
+  HASH_NEXT(&(i_)->i, _q);						\
+  (p) = (void *)_q;							\
+} while (0)
+
 extern void *sym_next(sym_iter */*i*/);
 
 /*----- That's all, folks -------------------------------------------------*/