1 files changed, 59 insertions, 6 deletions
diff --git a/tools/build/v2/engine/hash.h b/tools/build/v2/engine/hash.h
index 7195b4146f..65db56c1c5 100644
--- a/tools/build/v2/engine/hash.h
+++ b/tools/build/v2/engine/hash.h
@@ -11,15 +11,68 @@
 #ifndef BOOST_JAM_HASH_H
 #define BOOST_JAM_HASH_H
 
+/*
+ * An opaque struct representing an item in the
+ * hash table.  The first element of every struct
+ * stored in the table must be an OBJECT * which
+ * is treated as the key.
+ */
 typedef struct hashdata HASHDATA;
 
-struct hash * hashinit     ( int datalen, char * name );
-int           hashitem     ( struct hash * hp, HASHDATA * * data, int enter );
-void          hashdone     ( struct hash * hp );
+/*
+ * hashinit() - initialize a hash table, returning a handle.
+ * datalen is the size of the items.  name is used for debugging.
+ */
+struct hash * hashinit     ( int datalen, const char * name );
+
+/*
+ * hash_free() - free a hash table, given its handle
+ */
+void hash_free( struct hash * hp );
+void hashdone( struct hash * hp );
+
+/*
+ * hashenumerate() - call f(i, data) on each item, i in the hash
+ * table.  The order of the items is unspecified.
+ */
 void          hashenumerate( struct hash * hp, void (* f)( void *, void * ), void * data );
-int           hash_free    ( struct hash * hp, HASHDATA * data);
 
-#define hashenter( hp, data ) ( !hashitem( hp, data, !0 ) )
-#define hashcheck( hp, data ) hashitem( hp, data, 0 )
+/*
+ * hash_insert() - insert a new item in a hash table, or return an
+ * existing one.
+ *
+ * Preconditions:
+ *   - hp must be a hash table created by hashinit
+ *   - key must be an object created by object_new
+ *
+ * Postconditions:
+ *   - if the key does not already exist in the hash
+ *     table, *found == 0 and the result will be a
+ *     pointer to an uninitialized item.  The key
+ *     of the new item must be set to a value equal to
+ *     key before any further operations on the
+ *     hash table except hashdone.
+ *   - if the key is present then *found == 1 and
+ *     the result is a pointer to the existing
+ *     record.
+ */
+HASHDATA *    hash_insert  ( struct hash * hp, OBJECT * key, int * found );
+
+/*
+ * hash_find() - find a record in the table or NULL if none exists
+ */
+HASHDATA *    hash_find    ( struct hash * hp, OBJECT * key );
+
+struct hashstats {
+    int count;
+    int num_items;
+    int tab_size;
+    int item_size;
+    int sets;
+};
+
+void hashstats_init( struct hashstats * stats );
+void hashstats_add( struct hashstats * stats, struct hash * hp );
+void hashstats_print( struct hashstats * stats, const char * name );
 
 #endif