Changeset 739d00a in mainline for uspace/lib/libc/generic/libadt/hash_table.c

Timestamp:

2008-03-06T22:18:23Z (17 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

3298ddc

Parents:

7b6d98b

Message:

Add hash_table_destroy().

File:

• uspace/lib/libc/generic/libadt/hash_table.c (modified) (9 diffs)

uspace/lib/libc/generic/libadt/hash_table.c

@@ -1 +1 @@
 /*
- * Copyright (c) 2006 Jakub Jermar
+ * Copyright (c) 2008 Jakub Jermar
  * All rights reserved.
  *
@@ -47 +47 @@
 /** Create chained hash table.
  *
- * @param h Hash table structure. Will be initialized by this call.
- * @param m Number of slots in the hash table.
- * @param max_keys Maximal number of keys needed to identify an item.
- * @param op Hash table operations structure.
- * @return true on success
+ * @param h             Hash table structure. Will be initialized by this call.
+ * @param m             Number of hash table buckets.
+ * @param max_keys      Maximal number of keys needed to identify an item.
+ * @param op            Hash table operations structure.
+ * @return              True on success
  */
-int hash_table_create(hash_table_t *h, hash_count_t m, hash_count_t max_keys, hash_table_operations_t *op)
+int hash_table_create(hash_table_t *h, hash_count_t m, hash_count_t max_keys,
+    hash_table_operations_t *op)
 {
         hash_count_t i;
@@ -77 +78 @@
 }
 
-/** Insert item into hash table.
+/** Destroy a hash table instance.
  *
- * @param h Hash table.
- * @param key Array of all keys necessary to compute hash index.
- * @param item Item to be inserted into the hash table.
+ * @param h             Hash table to be destroyed.
+ */
+void hash_table_destroy(hash_table_t *h)
+{
+        assert(h);
+        assert(h->entry);
+        free(h->entry);
+}
+
+/** Insert item into a hash table.
+ *
+ * @param h             Hash table.
+ * @param key           Array of all keys necessary to compute hash index.
+ * @param item          Item to be inserted into the hash table.
  */
 void hash_table_insert(hash_table_t *h, unsigned long key[], link_t *item)
@@ -98 +110 @@
 /** Search hash table for an item matching keys.
  *
- * @param h Hash table.
- * @param key Array of all keys needed to compute hash index.
+ * @param h             Hash table.
+ * @param key           Array of all keys needed to compute hash index.
  *
- * @return Matching item on success, NULL if there is no such item.
+ * @return              Matching item on success, NULL if there is no such item.
  */
 link_t *hash_table_find(hash_table_t *h, unsigned long key[])
@@ -113 +125 @@
         assert(chain < h->entries);
         
-        for (cur = h->entry[chain].next; cur != &h->entry[chain]; cur = cur->next) {
+        for (cur = h->entry[chain].next; cur != &h->entry[chain];
+            cur = cur->next) {
                 if (h->op->compare(key, h->max_keys, cur)) {
                         /*
@@ -129 +142 @@
  * For each removed item, h->remove_callback() is called.
  *
- * @param h Hash table.
- * @param key Array of keys that will be compared against items of the hash table.
- * @param keys Number of keys in the 'key' array.
+ * @param h             Hash table.
+ * @param key           Array of keys that will be compared against items of
+ *                      the hash table.
+ * @param keys          Number of keys in the 'key' array.
  */
 void hash_table_remove(hash_table_t *h, unsigned long key[], hash_count_t keys)
@@ -138 +152 @@
         link_t *cur;
 
-        assert(h && h->op && h->op->hash && h->op->compare && h->op->remove_callback);
+        assert(h && h->op && h->op->hash && h->op->compare &&
+            h->op->remove_callback);
         assert(keys <= h->max_keys);
         
@@ -144 +159 @@
 
                 /*
-                 * All keys are known, hash_table_find() can be used to find the entry.
+                 * All keys are known, hash_table_find() can be used to find the
+                 * entry.
                  */
         
@@ -160 +176 @@
          */
         for (chain = 0; chain < h->entries; chain++) {
-                for (cur = h->entry[chain].next; cur != &h->entry[chain]; cur = cur->next) {
+                for (cur = h->entry[chain].next; cur != &h->entry[chain];
+                    cur = cur->next) {
                         if (h->op->compare(key, keys, cur)) {
                                 link_t *hlp;