From f2ad275bb3619165357b369ac083ae2f73d5a543 Mon Sep 17 00:00:00 2001
From: Matthias Braun <matthias.braun@kit.edu>
Date: Mon, 16 Jul 2012 16:32:55 +0200
Subject: [PATCH] rework hashset

Only define functions for which the user provided a renaming #define
(instead of forcing the users to create name for everything)
Only define iterator struct if a rename #define is present (instead of
forcing the user to define NO_ITERATOR if he doesn't want one)
---
 ir/adt/hashset.c        | 70 +++++++++++++++++------------------------
 ir/adt/hashset.h        |  4 +--
 ir/ir/irlinkednodemap.c |  1 -
 ir/ir/irlinkednodemap.h |  4 ---
 ir/ir/irlinkednodeset.c |  1 -
 ir/ir/irlinkednodeset.h |  4 ---
 ir/ir/valueset.c        |  1 -
 ir/ir/valueset.h        |  4 ---
 8 files changed, 31 insertions(+), 58 deletions(-)

diff --git a/ir/adt/hashset.c b/ir/adt/hashset.c
index 563c46e8b..e0cf70c77 100644
--- a/ir/adt/hashset.c
+++ b/ir/adt/hashset.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2012 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -36,7 +36,7 @@
  *  <li><b>Hash(hashset,key)</b> calculates the hash value for a given key</li>
  * </ul>
  *
- * Note that by default it is assumed that the data values themselfes are used
+ * Note that by default it is assumed that the data values themselves are used
  * as keys. However you can change that with additional defines:
  *
  * <ul>
@@ -83,7 +83,7 @@
 
 #ifdef DO_REHASH
 #define HashSetEntry                   ValueType
-#define EntrySetHash(entry,new_hash)   (void)0
+#define EntrySetHash(entry,new_hash)   ((void)0)
 #define EntryGetHash(self,entry)       Hash(self, GetKey(entry))
 #define EntryGetValue(entry)           (entry)
 #else /* ! DO_REHASH */
@@ -174,41 +174,7 @@
 
 #define ILLEGAL_POS       ((size_t)-1)
 
-/* check that all needed functions are defined */
-#ifndef hashset_init
-#error You have to redefine hashset_init
-#endif
-#ifndef hashset_init_size
-#error You have to redefine hashset_init_size
-#endif
-#ifndef hashset_destroy
-#error You have to redefine hashset_destroy
-#endif
-#ifndef hashset_insert
-#error You have to redefine hashset_insert
-#endif
-#ifndef hashset_remove
-#error You have to redefine hashset_remove
-#endif
-#ifndef hashset_find
-#error You have to redefine hashset_find
-#endif
-#ifndef hashset_size
-#error You have to redefine hashset_size
-#endif
-
-#ifndef NO_ITERATOR
-#ifndef hashset_iterator_init
-#error You have to redefine hashset_iterator_init
-#endif
-#ifndef hashset_iterator_next
-#error You have to redefine hashset_iterator_next
-#endif
-#ifndef hashset_remove_iterator
-#error You have to redefine hashset_remove_iterator
-#endif
-#endif
-
+#ifdef hashset_size
 /**
  * Returns the number of elements in the hashset
  */
@@ -216,6 +182,12 @@ size_t hashset_size(const HashSet *self)
 {
 	return self->num_elements - self->num_deleted;
 }
+#else
+static inline size_t hashset_size(const HashSet *self)
+{
+	return self->num_elements - self->num_deleted;
+}
+#endif
 
 /**
  * Inserts an element into a hashset without growing the set (you have to make
@@ -412,6 +384,7 @@ static inline void maybe_shrink(HashSet *self)
 	resize(self, resize_to);
 }
 
+#ifdef hashset_insert
 /**
  * Insert an element into the hashset. If no element with the given key exists yet,
  * then a new one is created and initialized with the InitData function.
@@ -432,7 +405,9 @@ FindReturnValue hashset_insert(HashSet *self, KeyType key)
 	maybe_grow(self);
 	return InsertReturnValue(insert_nogrow(self, key));
 }
+#endif
 
+#ifdef hashset_find
 /**
  * Searches for an element with key @p key.
  *
@@ -468,7 +443,9 @@ FindReturnValue hashset_find(const HashSet *self, ConstKeyType key)
 		assert(num_probes < num_buckets);
 	}
 }
+#endif
 
+#ifdef hashset_remove
 /**
  * Removes an element from a hashset. Does nothing if the set doesn't contain
  * the element.
@@ -510,6 +487,7 @@ void hashset_remove(HashSet *self, ConstKeyType key)
 		assert(num_probes < num_buckets);
 	}
 }
+#endif
 
 /**
  * Initializes hashset with a specific size
@@ -536,6 +514,7 @@ static inline void init_size(HashSet *self, size_t initial_size)
 	reset_thresholds(self);
 }
 
+#ifdef hashset_init
 /**
  * Initializes a hashset with the default size. The memory for the set has to
  * already allocated.
@@ -544,7 +523,9 @@ void hashset_init(HashSet *self)
 {
 	init_size(self, HT_MIN_BUCKETS);
 }
+#endif
 
+#ifdef hashset_destroy
 /**
  * Destroys a hashset, freeing all used memory (except the memory for the
  * HashSet struct itself).
@@ -559,7 +540,9 @@ void hashset_destroy(HashSet *self)
 	self->entries = NULL;
 #endif
 }
+#endif
 
+#ifdef hashset_init_size
 /**
  * Initializes a hashset expecting expected_element size.
  */
@@ -576,8 +559,9 @@ void hashset_init_size(HashSet *self, size_t expected_elements)
 	po2size     = ceil_po2(needed_size);
 	init_size(self, po2size);
 }
+#endif
 
-#ifndef NO_ITERATOR
+#ifdef hashset_iterator_init
 /**
  * Initializes a hashset iterator. The memory for the allocator has to be
  * already allocated.
@@ -592,7 +576,9 @@ void hashset_iterator_init(HashSetIterator *self, const HashSet *hashset)
 	self->entries_version = hashset->entries_version;
 #endif
 }
+#endif
 
+#ifdef hashset_iterator_next
 /**
  * Returns the next value in the iterator or NULL if no value is left
  * in the hashset.
@@ -615,7 +601,9 @@ ValueType hashset_iterator_next(HashSetIterator *self)
 	self->current_bucket = current_bucket;
 	return EntryGetValue(*current_bucket);
 }
+#endif
 
+#ifdef hashset_remove_iterator
 /**
  * Removes the element the iterator points to. Removing an element a second time
  * has no result.
@@ -636,6 +624,6 @@ void hashset_remove_iterator(HashSet *self, const HashSetIterator *iter)
 	self->num_deleted++;
 	self->consider_shrink = 1;
 }
-#endif /* NO_ITERATOR */
+#endif
 
-#endif /* HashSet */
+#endif
diff --git a/ir/adt/hashset.h b/ir/adt/hashset.h
index 2d95a3607..a254a494a 100644
--- a/ir/adt/hashset.h
+++ b/ir/adt/hashset.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2012 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -55,7 +55,7 @@ struct HashSet {
 #endif
 };
 
-#ifndef NO_ITERATOR
+#ifdef HashSetIterator
 struct HashSetIterator {
 	HashSetEntry *current_bucket;
 	HashSetEntry *end;
diff --git a/ir/ir/irlinkednodemap.c b/ir/ir/irlinkednodemap.c
index ff8d39825..d1e6de9ef 100644
--- a/ir/ir/irlinkednodemap.c
+++ b/ir/ir/irlinkednodemap.c
@@ -61,7 +61,6 @@ ir_lnk_nodemap_entry_t *ir_lnk_nodemap_find_(const ir_lnk_nodemap_t *self,
 #define ADDITIONAL_INIT         INIT_LIST_HEAD(&self->elem_list); INIT_LIST_HEAD(&self->all_iters);
 #define ADDITIONAL_TERM         INIT_LIST_HEAD(&self->elem_list); INIT_LIST_HEAD(&self->all_iters);
 
-#define NO_ITERATOR
 #define HAVE_OWN_RESIZE
 
 #include "hashset.c"
diff --git a/ir/ir/irlinkednodemap.h b/ir/ir/irlinkednodemap.h
index 5956fa834..f58c7f169 100644
--- a/ir/ir/irlinkednodemap.h
+++ b/ir/ir/irlinkednodemap.h
@@ -46,19 +46,15 @@ typedef struct ir_lnk_nodemap_entry_t {
 } ir_lnk_nodemap_entry_t;
 
 #define HashSet          ir_lnk_nodemap_t
-#define HashSetIterator  ir_lnk_nodemap_iterator_t
 #define ValueType        ir_lnk_nodemap_entry_t
 #define ADDITIONAL_DATA  list_head elem_list; list_head all_iters;
 #define DO_REHASH
-#define NO_ITERATOR
 
 #include "hashset.h"
 
-#undef NO_ITERATOR
 #undef DO_REHASH
 #undef ADDITIONAL_DATA
 #undef ValueType
-#undef HashSetIterator
 #undef HashSet
 
 typedef struct ir_lnk_nodemap_t ir_lnk_nodemap_t;
diff --git a/ir/ir/irlinkednodeset.c b/ir/ir/irlinkednodeset.c
index fe17f26a3..86fdd52ba 100644
--- a/ir/ir/irlinkednodeset.c
+++ b/ir/ir/irlinkednodeset.c
@@ -60,7 +60,6 @@ ir_lnk_nodeset_entry_t *ir_lnk_nodeset_find_(const ir_lnk_nodeset_t *nodeset, co
 #define ADDITIONAL_INIT         INIT_LIST_HEAD(&self->elem_list); INIT_LIST_HEAD(&self->all_iters);
 #define ADDITIONAL_TERM         INIT_LIST_HEAD(&self->elem_list); INIT_LIST_HEAD(&self->all_iters);
 
-#define NO_ITERATOR
 #define HAVE_OWN_RESIZE
 
 #include "hashset.c"
diff --git a/ir/ir/irlinkednodeset.h b/ir/ir/irlinkednodeset.h
index 63f12e692..1edb7bdc6 100644
--- a/ir/ir/irlinkednodeset.h
+++ b/ir/ir/irlinkednodeset.h
@@ -35,19 +35,15 @@ typedef struct ir_lnk_nodeset_entry_t {
 } ir_lnk_nodeset_entry_t;
 
 #define HashSet          ir_lnk_nodeset_t
-#define HashSetIterator  ir_lnk_nodeset_iterator_t
 #define ValueType        ir_lnk_nodeset_entry_t
 #define ADDITIONAL_DATA  list_head elem_list; list_head all_iters;
 #define DO_REHASH
-#define NO_ITERATOR
 
 #include "hashset.h"
 
-#undef NO_ITERATOR
 #undef DO_REHASH
 #undef ADDITIONAL_DATA
 #undef ValueType
-#undef HashSetIterator
 #undef HashSet
 
 typedef struct ir_lnk_nodeset_t ir_lnk_nodeset_t;
diff --git a/ir/ir/valueset.c b/ir/ir/valueset.c
index 30531a9fd..c3535dfa8 100644
--- a/ir/ir/valueset.c
+++ b/ir/ir/valueset.c
@@ -62,7 +62,6 @@ ir_valueset_entry_t *ir_valueset_find_(const ir_valueset_t *self,
 #define ADDITIONAL_INIT         INIT_LIST_HEAD(&self->elem_list); INIT_LIST_HEAD(&self->all_iters);
 #define ADDITIONAL_TERM         INIT_LIST_HEAD(&self->elem_list); INIT_LIST_HEAD(&self->all_iters);
 
-#define NO_ITERATOR
 #define HAVE_OWN_RESIZE
 
 #include "hashset.c"
diff --git a/ir/ir/valueset.h b/ir/ir/valueset.h
index 079b7580a..8a52d9ff1 100644
--- a/ir/ir/valueset.h
+++ b/ir/ir/valueset.h
@@ -36,18 +36,14 @@ typedef struct ir_valueset_entry_t {
 } ir_valueset_entry_t;
 
 #define HashSet          ir_valueset_t
-#define HashSetIterator  ir_valueset_iterator_t
 #define ValueType        ir_valueset_entry_t
 #define ADDITIONAL_DATA  list_head elem_list; list_head all_iters;
 #undef DO_REHASH
-#define NO_ITERATOR
 
 #include "hashset.h"
 
-#undef NO_ITERATOR
 #undef ADDITIONAL_DATA
 #undef ValueType
-#undef HashSetIterator
 #undef HashSet
 
 typedef struct ir_valueset_t ir_valueset_t;
-- 
2.20.1