summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorJosé Fonseca <jrfonseca@tungstengraphics.com>2008-03-13 09:58:29 +0000
committerJosé Fonseca <jrfonseca@tungstengraphics.com>2008-03-13 10:23:02 +0000
commite584eb888fac90783c5f62333a39e6735be3e488 (patch)
treef393263cd71fd24e6ad2451d3534a433c6ed0b28 /src
parent8506e41dc080e20286709ab93b728aa5162f3c87 (diff)
gallium: Add a bit of documentation to cso_hash.
Diffstat (limited to 'src')
-rw-r--r--src/gallium/auxiliary/cso_cache/cso_hash.h49
1 files changed, 34 insertions, 15 deletions
diff --git a/src/gallium/auxiliary/cso_cache/cso_hash.h b/src/gallium/auxiliary/cso_cache/cso_hash.h
index 84b45a5963e..a3a65b68c84 100644
--- a/src/gallium/auxiliary/cso_cache/cso_hash.h
+++ b/src/gallium/auxiliary/cso_cache/cso_hash.h
@@ -26,19 +26,20 @@
**************************************************************************/
/**
- This file provides a hash implementation that is capable of dealing
- with collisions. It stores colliding entries in linked list. All
- functions operating on the hash return an iterator. The iterator
- itself points to the collision list. If there wasn't any collision
- the list will have just one entry, otherwise client code should
- iterate over the entries to find the exact entry among ones that
- had the same key (e.g. memcmp could be used on the data to check
- that)
-*/
- /*
- * Authors:
- * Zack Rusin <zack@tungstengraphics.com>
- */
+ * @file
+ * Hash table implementation.
+ *
+ * This file provides a hash implementation that is capable of dealing
+ * with collisions. It stores colliding entries in linked list. All
+ * functions operating on the hash return an iterator. The iterator
+ * itself points to the collision list. If there wasn't any collision
+ * the list will have just one entry, otherwise client code should
+ * iterate over the entries to find the exact entry among ones that
+ * had the same key (e.g. memcmp could be used on the data to check
+ * that)
+ *
+ * @author Zack Rusin <zack@tungstengraphics.com>
+ */
#ifndef CSO_HASH_H
#define CSO_HASH_H
@@ -48,24 +49,38 @@
extern "C" {
#endif
+
struct cso_hash;
struct cso_node;
+
struct cso_hash_iter {
struct cso_hash *hash;
struct cso_node *node;
};
+
struct cso_hash *cso_hash_create(void);
void cso_hash_delete(struct cso_hash *hash);
+
int cso_hash_size(struct cso_hash *hash);
+
+/**
+ * Create a list of objects and just add entry with the same key to the list.
+ */
struct cso_hash_iter cso_hash_insert(struct cso_hash *hash, unsigned key,
void *data);
+
void *cso_hash_take(struct cso_hash *hash, unsigned key);
+
struct cso_hash_iter cso_hash_first_node(struct cso_hash *hash);
+
+/**
+ * Return an iterator pointing to the first entry in the collision list.
+ */
struct cso_hash_iter cso_hash_find(struct cso_hash *hash, unsigned key);
@@ -73,12 +88,16 @@ int cso_hash_iter_is_null(struct cso_hash_iter iter);
unsigned cso_hash_iter_key(struct cso_hash_iter iter);
void *cso_hash_iter_data(struct cso_hash_iter iter);
+
struct cso_hash_iter cso_hash_iter_next(struct cso_hash_iter iter);
struct cso_hash_iter cso_hash_iter_prev(struct cso_hash_iter iter);
-/* KW: a convenience routine:
- */
+/**
+ * Convenience routine to iterate over the collision list while doing a memory
+ * comparison to see which entry in the list is a direct copy of our template
+ * and returns that entry.
+ */
void *cso_hash_find_data_from_template( struct cso_hash *hash,
unsigned hash_key,
void *templ,