nsz Git - libfirm/blob - include/libfirm/adt/pset_new.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @date    17.03.2007
  23  * @brief   hashset containing pointers
  24  * @author  Matthias Braun
  25  * @version $Id$
  26  *
  27  * @note This has been named pset_new_new for now until all code has been
  28  *       changed to use this instead of the old deprecated pset_new functions!
  29  *       This version performs better than pset in terms of speed and memory
  30  *       usage and allows multiple iterators over the set
  31  */
  32 #ifndef FIRM_ADT_PSET_NEW_H
  33 #define FIRM_ADT_PSET_NEW_H
  34
  35 #include "../begin.h"
  36
  37 #define HashSet          pset_new_t
  38 #define HashSetIterator  pset_new_iterator_t
  39 #define ValueType        void*
  40 #define DO_REHASH
  41 #include "hashset.h"
  42 #undef DO_REHASH
  43 #undef HashSet
  44 #undef HashSetIterator
  45 #undef ValueType
  46
  47 typedef struct pset_new_t           pset_new_t;
  48 typedef struct pset_new_iterator_t  pset_new_iterator_t;
  49
  50 /**
  51  * Initializes a pset_new
  52  *
  53  * @param pset_new   Pointer to allocated space for the pset_new
  54  */
  55 void pset_new_init(pset_new_t *pset_new);
  56
  57 /**
  58  * Initializes a pset_new
  59  *
  60  * @param pset_new            Pointer to allocated space for the pset_new
  61  * @param expected_elements   Number of elements expected in the pset_new (roughly)
  62  */
  63 void pset_new_init_size(pset_new_t *pset_new, size_t expected_elements);
  64
  65 /**
  66  * Destroys a pset_new and frees the memory allocated for hashtable. The memory of
  67  * the pset_new itself is not freed.
  68  *
  69  * @param pset_new   Pointer to the pset_new
  70  */
  71 void pset_new_destroy(pset_new_t *pset_new);
  72
  73 /**
  74  * Inserts an element into a pset_new.
  75  *
  76  * @param pset_new   Pointer to the pset_new
  77  * @param ptr    Pointer to insert into the pset_new
  78  * @returns      1 if the pointer was inserted, 0 if it was already there
  79  */
  80 int pset_new_insert(pset_new_t *pset_new, void *ptr);
  81
  82 /**
  83  * Removes an element from a pset_new. Does nothing if the pset_new doesn't contain the
  84  * element.
  85  *
  86  * @param pset_new   Pointer to the pset_new
  87  * @param ptr    Pointer to remove from the pset_new
  88  */
  89 void pset_new_remove(pset_new_t *pset_new, const void *ptr);
  90
  91 /**
  92  * Tests whether a pset_new contains a pointer
  93  *
  94  * @param pset_new   Pointer to the pset_new
  95  * @param ptr    The pointer to test
  96  * @returns      1 @p pset_new contains the @p ptr, 0 otherwise
  97  */
  98 int pset_new_contains(const pset_new_t *pset_new, const void *ptr);
  99
 100 /**
 101  * Returns the number of pointers contained in the pset_new
 102  *
 103  * @param pset_new   Pointer to the pset_new
 104  * @returns      Number of pointers contained in the pset_new
 105  */
 106 size_t pset_new_size(const pset_new_t *pset_new);
 107
 108 /**
 109  * Initializes a pset_new iterator. Sets the iterator before the first element in
 110  * the pset_new.
 111  *
 112  * @param iterator   Pointer to already allocated iterator memory
 113  * @param pset_new       Pointer to the pset_new
 114  */
 115 void pset_new_iterator_init(pset_new_iterator_t *iterator, const pset_new_t *pset_new);
 116
 117 /**
 118  * Advances the iterator and returns the current element or NULL if all elements
 119  * in the pset_new have been processed.
 120  * @attention It is not allowed to use pset_new_insert or pset_new_remove while
 121  *            iterating over a pset_new; pset_new_remove_iter is allowed.
 122  *
 123  * @param iterator  Pointer to the pset_new iterator.
 124  * @returns         Next element in the pset_new or NULL
 125  */
 126 void* pset_new_iterator_next(pset_new_iterator_t *iterator);
 127
 128 /**
 129  * Removes the element that the iterator currently points to from the hashset.
 130  *
 131  * @param pset_new      Pointer to the pset_new
 132  * @param iterator  Pointer to the iterator
 133  */
 134 void pset_new_remove_iterator(pset_new_t *pset_new, const pset_new_iterator_t *iterator);
 135
 136 /**
 137  * Convenience macro for iterating over a pset_new.
 138  */
 139 #define foreach_pset_new(pset_new, ptr, iter)    \
 140         for(pset_new_iterator_init(&iter, pset_new), \
 141                 ptr = pset_new_iterator_next(&iter);     \
 142                 ptr != NULL; ptr = pset_new_iterator_next(&iter))
 143
 144 #include "../end.h"
 145
 146 #endif