Cosmetic changes

[libfirm] / ir / adt / pset.h

diff --git a/ir/adt/pset.h b/ir/adt/pset.h
index f32095b..4ffc69b 100644 (file)
--- a/ir/adt/pset.h
+++ b/ir/adt/pset.h
@@ -15,16 +15,37 @@
 
 #include <stddef.h>
 
+#include "hashptr.h"
+#include "iterator.h"
+
+/**
+ * The default comparison function for pointers.
+ * @param x A pointer.
+ * @param y A pointer.
+ * @return 0 if @p x and @p y are equal. Some value != 0 otherwise.
+ */
+int pset_default_ptr_cmp(const void *x, const void *y);
+
 /**
  * The abstract type of a pset (Set of pointers).
  *
  * This kind of sets stores only pointer to elements, the elements itself
- * must be stored somewere else.
+ * must be stored somewhere else.
  *
  * @see set
  */
 typedef struct pset pset;
 
+/*
+ * Define some convenience macros using the predefined hash function.
+ */
+#define pset_insert_ptr(set,key)  pset_insert(set, key, HASH_PTR(key))
+#define pset_hinsert_ptr(set,key) pset_hinsert(set, key, HASH_PTR(key))
+#define pset_remove_ptr(set,key)  pset_remove(set, key, HASH_PTR(key))
+#define pset_find_ptr(set,key)    pset_find(set, key, HASH_PTR(key))
+#define pset_new_ptr(slots)       new_pset(pset_default_ptr_cmp, slots)
+#define pset_new_ptr_default()    pset_new_ptr(64)
+
 /** The entry of a pset, representing an element pointer in the set and it's meta-information */
 typedef struct {
   unsigned hash;
@@ -79,7 +100,7 @@ int pset_count (pset *pset);
  * @param hash  the hash value of key
  *
  * @return
- *    the pointer of the found element in the pset of NULL if it was not found
+ *    the pointer of the found element in the pset or NULL if it was not found
  */
 void *pset_find (pset *pset, const void *key, unsigned hash);
 
@@ -93,7 +114,7 @@ void *pset_find (pset *pset, const void *key, unsigned hash);
  * @return a pointer to the inserted element
  *
  * @note
- *    It is not possible to insert on element more than once. If a element
+ *    It is not possible to insert an element more than once. If an element
  *    that should be inserted is already in the set, this functions does
  *    nothing but returning its already existing set_entry.
 
@@ -110,7 +131,7 @@ void *pset_insert (pset *pset, const void *key, unsigned hash);
  * @return a pointer to the pset_entry of the inserted element
  *
  * @note
- *    It is not possible to insert on element more than once. If a element
+ *    It is not possible to insert an element more than once. If an element
  *    that should be inserted is already in the pset, this functions does
  *    nothing but returning its pset_entry.
  */
@@ -119,8 +140,8 @@ pset_entry *pset_hinsert (pset *pset, const void *key, unsigned hash);
 /**
  * Removes an element from a pset.
  *
- * @param pset  the pset to insert in
- * @param key   a pointer to the element to be inserted
+ * @param pset  the pset to delete in
+ * @param key   a pointer to the element to be deleted
  * @param hash  the hash-value of the element
  *
  * @return
@@ -128,6 +149,7 @@ pset_entry *pset_hinsert (pset *pset, const void *key, unsigned hash);
  *
  * @remark
  *    The current implementation did not allow to remove non-existing elements.
+ *    @@@ so, does it do now?
  *    Further, it is allowed to remove elements during an iteration
  *    including the current one.
  */
@@ -161,6 +183,23 @@ void *pset_next (pset *pset);
  */
 void pset_break (pset *pset);
 
+/**
+ * Iterates oven an pset.
+ *
+ * @param pset   the pset
+ * @param entry  the iterator
+ */
+#define foreach_pset(pset, entry) for (entry = pset_first(pset); entry; entry = pset_next(pset))
+
+/**
+ * Inserts all elements of the pointer set src into
+ * the set target (union).
+ *
+ * @param target  the target set, will contain the union
+ * @param src     a set, will not be changed
+ */
+void pset_insert_pset_ptr(pset *target, pset *src);
+
 #define new_pset(cmp, slots) (PSET_TRACE (new_pset) ((cmp), (slots)))
 #define pset_find(pset, key, hash) \
   _pset_search ((pset), (key), (hash), _pset_find)