Added is_Const

[libfirm] / ir / adt / pset.h

diff --git a/ir/adt/pset.h b/ir/adt/pset.h
index 059005f..10549e8 100644 (file)
--- a/ir/adt/pset.h
+++ b/ir/adt/pset.h
@@ -15,6 +15,17 @@
 
 #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).
  *
@@ -25,6 +36,18 @@
  */
 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)
+void    pset_insert_pset_ptr(pset *target, pset *src); /* Insertss all elements of src in target. */
+
+
 /** The entry of a pset, representing an element pointer in the set and it's meta-information */
 typedef struct {
   unsigned hash;
@@ -79,7 +102,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 +116,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 +133,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 +142,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
@@ -182,10 +205,15 @@ void pset_stats (pset *pset);
 
 #ifdef DEBUG
 /**
- * Describe a set by printing all elements
- * to stdout.
+ * Describe a pset.
+ *
+ * Writes a description of a set to stdout. The description includes:
+ * - a header telling how many elements (nkey) and segments (nseg) are in use
+ * - for every collision chain the number of element with its hash values
+ *
+ * @param pset  the pset
  */
-void pset_describe (pset *);
+void pset_describe (pset *pset);
 #endif
 
 /* @@@ NYI */