/*
- * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
*
* This file is part of libFirm.
*
* @brief optimized version of set for sets containing only pointers
* (deprecated)
* @author Markus Armbruster
- * @version $Id$
- * @note This code has been deprecated. Use pset_new or cpset for new
- * code.
*/
#ifndef FIRM_ADT_PSET_H
#define FIRM_ADT_PSET_H
#include <stddef.h>
#include "hashptr.h"
-#include "iterator.h"
+
+#include "../begin.h"
+
+/**
+ * @ingroup adt
+ * @defgroup pset Pointer Set
+ * (Hash)sets containing pointers.
+ * @note This code has been deprecated. Use pset_new or cpset for new code.
+ * @{
+ */
/**
* The default comparison function for pointers.
* @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);
+FIRM_API int pset_default_ptr_cmp(const void *x, const void *y);
/**
* The abstract type of a pset (Set of pointers).
*/
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))
+/** Inserts into pointer set with default hash function. */
+#define pset_insert_ptr(set,key) pset_insert(set, key, hash_ptr(key))
+/** Inserts into pointer set with default hash function and return entry */
+#define pset_hinsert_ptr(set,key) pset_hinsert(set, key, hash_ptr(key))
+/** Removes pointer from pointer set with default hash function */
+#define pset_remove_ptr(set,key) pset_remove(set, key, hash_ptr(key))
+/** Finds pointer in pointer set with default hash function */
+#define pset_find_ptr(set,key) pset_find(set, key, hash_ptr(key))
+/** Creates new pointer set with default compare function */
#define pset_new_ptr(slots) new_pset(pset_default_ptr_cmp, slots)
+/** Creates new pointer set with default compare function and default size */
#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 */
+/** The entry of a pset, representing an element pointer in the set and its meta-information */
typedef struct {
- unsigned hash;
- void *dptr;
+ unsigned hash; /**< hash value of element */
+ void *dptr; /**< pointer to element data */
} pset_entry;
/**
* Creates a new pset.
*
* @param func The compare function of this pset.
- * @param slots Initial number of collision chains. I.e., #slots
+ * @param slots Initial number of collision chains. I.e., \#slots
* different keys can be hashed without collisions.
*
* @returns
* created pset
*/
-pset *new_pset (pset_cmp_fun func, int slots);
+FIRM_API pset *new_pset(pset_cmp_fun func, size_t slots);
/**
* Deletes a pset.
* @param pset the pset
*
* @note
- * This does NOT delete the elements of this pset, just it's pointers!
+ * This does NOT delete the elements of this pset, just its pointers!
*/
-void del_pset (pset *pset);
+FIRM_API void del_pset(pset *pset);
/**
* Returns the number of elements in a pset.
*
* @param pset the pset
*/
-int pset_count (pset *pset);
+FIRM_API size_t pset_count(pset *pset);
/**
* Searches an element pointer in a pset.
* @return
* 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);
+FIRM_API void *pset_find(pset *pset, const void *key, unsigned hash);
/**
* Inserts an element pointer into a pset.
* nothing but returning its already existing set_entry.
*/
-void *pset_insert (pset *pset, const void *key, unsigned hash);
+FIRM_API void *pset_insert(pset *pset, const void *key, unsigned hash);
/**
* Inserts an element pointer into a pset and returns its pset_entry.
* that should be inserted is already in the pset, this functions does
* nothing but returning its pset_entry.
*/
-pset_entry *pset_hinsert (pset *pset, const void *key, unsigned hash);
+FIRM_API pset_entry *pset_hinsert(pset *pset, const void *key, unsigned hash);
/**
* Removes an element from a pset.
* Further, it is allowed to remove elements during an iteration
* including the current one.
*/
-void *pset_remove (pset *pset, const void *key, unsigned hash);
+FIRM_API void *pset_remove(pset *pset, const void *key, unsigned hash);
/**
* Returns the first element of a pset.
*
* @return a pointer to the element or NULL if the set is empty
*/
-void *pset_first (pset *pset);
+FIRM_API void *pset_first(pset *pset);
/**
* Returns the next element of a pset.
* @return a pointer to the next element or NULL if the
* iteration is finished
*/
-void *pset_next (pset *pset);
+FIRM_API void *pset_next(pset *pset);
/**
* Breaks the iteration of a set. Must be called before
*
* @param pset the pset
*/
-void pset_break (pset *pset);
+FIRM_API void pset_break(pset *pset);
/**
* Iterates oven an pset.
*
* @param pset the pset
+ * @param type type of iterator variable
* @param entry the iterator
*/
-#define foreach_pset(pset, entry) for (entry = pset_first(pset); entry; entry = pset_next(pset))
+#define foreach_pset(pset, type, entry) for (type *entry = (type*)pset_first(pset); entry; entry = (type*)pset_next(pset))
/**
* Inserts all elements of the pointer set src into
* @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);
+FIRM_API void pset_insert_pset_ptr(pset *target, pset *src);
-#define new_pset(cmp, slots) (PSET_TRACE (new_pset) ((cmp), (slots)))
+/** @cond PRIVATE */
+
+#define new_pset(cmp, slots) ((new_pset) ((cmp), (slots)))
#define pset_find(pset, key, hash) \
_pset_search ((pset), (key), (hash), _pset_find)
#define pset_insert(pset, key, hash) \
#define pset_hinsert(pset, key, hash) \
((pset_entry *)_pset_search ((pset), (key), (hash), _pset_hinsert))
-#ifdef STATS
-/**
- * Prints statistics on a set to stdout.
- *
- * @param pset the pset
- */
-void pset_stats (pset *pset);
-#else
-# define pset_stats(s) ((void)0)
-#endif
-
-#ifdef DEBUG
-/**
- * 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 *pset);
-#endif
-
-/* @@@ NYI */
-#define PSET_VRFY(pset) (void)0
-
+typedef enum { _pset_find, _pset_insert, _pset_hinsert } _pset_action;
-/* Private */
+FIRM_API void *_pset_search(pset *, const void *, unsigned, _pset_action);
-typedef enum { _pset_find, _pset_insert, _pset_hinsert } _pset_action;
+/** @endcond */
-void *_pset_search (pset *, const void *, unsigned, _pset_action);
+/** @} */
-#if defined(DEBUG) && defined(HAVE_GNU_MALLOC)
-extern const char *pset_tag;
-# ifdef PSET_ID
-# define PSET_TRACE pset_tag = SET_ID,
-# else
-# define PSET_TRACE pset_tag = __FILE__,
-# endif
-#else /* !(DEBUG && HAVE_GNU_MALLOC) */
-# define PSET_TRACE
-#endif /* !(DEBUG && HAVE_GNU_MALLOC) */
+#include "../end.h"
#endif
projects / libfirm / blobdiff