nsz Git - libfirm/blob - ir/adt/pset.h

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/adt/pset.h
   4  * Purpose:     Declarations for pset.
   5  * Author:      Markus Armbruster
   6  * Modified by:
   7  * Created:     1999 by getting from fiasco
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 1995, 1996 Markus Armbruster
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13 #ifndef _PSET_H
  14 #define _PSET_H
  15
  16 #include <stddef.h>
  17
  18 /**
  19  * The abstract type of a pset (Set of pointers).
  20  *
  21  * This kind of sets stores only pointer to elements, the elements itself
  22  * must be stored somewere else.
  23  *
  24  * @see set
  25  */
  26 typedef struct pset pset;
  27
  28 /** The entry of a pset, representing an element pointer in the set and it's meta-information */
  29 typedef struct {
  30   unsigned hash;
  31   void *dptr;
  32 } pset_entry;
  33
  34 /**
  35  * The type of a set compare function.
  36  *
  37  * @param elt   pointer to an element
  38  * @param key   pointer to another element
  39  *
  40  * @return
  41  *    0 if the elements are identically, non-zero else
  42  */
  43 typedef int (*pset_cmp_fun) (const void *elt, const void *key);
  44
  45 /**
  46  * Creates a new pset.
  47  *
  48  * @param func    the compare function of this pset
  49  * @param slots   number of slots
  50  *
  51  * @returns
  52  *    created pset
  53  */
  54 pset *new_pset (pset_cmp_fun func, int slots);
  55
  56 /**
  57  * Deletes a pset.
  58  *
  59  * @note
  60  *    This does NOT delete the elements of this pset, just it's pointers!
  61  */
  62 void del_pset (pset *pset);
  63
  64 /**
  65  * Searches an element pointer in a pset.
  66  *
  67  * @param pset  the pset to search in
  68  * @param key   the element to is searched
  69  * @param hash  the hash value of key
  70  *
  71  * @return
  72  *    the pointer of the found element in the pset of NULL if it was not found
  73  */
  74 void *pset_find (pset *pset, const void *key, unsigned hash);
  75
  76 /**
  77  * Inserts an element pointer into a pset.
  78  *
  79  * @param pset  the pset to insert in
  80  * @param key   a pointer to the element to be inserted
  81  * @param hash  the hash-value of the element
  82  *
  83  * @return a pointer to the inserted element
  84  *
  85  * @note
  86  *    It is not possible to insert on element more than once. If a element
  87  *    that should be inserted is already in the set, this functions does
  88  *    nothing but returning its set_entry.
  89
  90  */
  91 void *pset_insert (pset *pset, const void *key, unsigned hash);
  92
  93 /**
  94  * Inserts an element pointer into a pset and returns its pset_entry.
  95  *
  96  * @param pset  the pset to insert in
  97  * @param key   a pointer to the element to be inserted
  98  * @param hash  the hash-value of the element
  99  *
 100  * @return a pointer to the pset_entry of the inserted element
 101  *
 102  * @note
 103  *    It is not possible to insert on element more than once. If a element
 104  *    that should be inserted is already in the pset, this functions does
 105  *    nothing but returning its pset_entry.
 106  */
 107 pset_entry *pset_hinsert (pset *pset, const void *key, unsigned hash);
 108
 109 /**
 110  * Removes an element from a pset.
 111  *
 112  * @param pset  the pset to insert in
 113  * @param key   a pointer to the element to be inserted
 114  * @param hash  the hash-value of the element
 115  *
 116  * @return
 117  *    the pointer to the removed element
 118  *
 119  * @remark
 120  *    The current implementation did not allow to remove non-existing elements
 121  */
 122 void *pset_remove (pset *pset, const void *key, unsigned hash);
 123
 124 /** returns the first element of a pset */
 125 void *pset_first (pset *pset);
 126
 127 /** returns the next element of a pset */
 128 void *pset_next (pset *pset);
 129
 130 /** Breaks the iteration of a set. Must be called before the next pset_first() call */
 131 void pset_break (pset *pset);
 132
 133 #define new_pset(cmp, slots) (PSET_TRACE (new_pset) ((cmp), (slots)))
 134 #define pset_find(pset, key, hash) \
 135   _pset_search ((pset), (key), (hash), _pset_find)
 136 #define pset_insert(pset, key, hash) \
 137   _pset_search ((pset), (key), (hash), _pset_insert)
 138 #define pset_hinsert(pset, key, hash) \
 139   ((pset_entry *)_pset_search ((pset), (key), (hash), _pset_hinsert))
 140
 141 #ifdef STATS
 142 void pset_stats (pset *);
 143 #else
 144 # define pset_stats(s) ((void)0)
 145 #endif
 146
 147 #ifdef DEBUG
 148 void pset_describe (pset *);
 149 #endif
 150
 151 /* @@@ NYI */
 152 #define PSET_VRFY(pset) (void)0
 153
 154
 155 /* Private */
 156
 157 typedef enum { _pset_find, _pset_insert, _pset_hinsert } _pset_action;
 158
 159 void *_pset_search (pset *, const void *, unsigned, _pset_action);
 160
 161 #if defined(DEBUG) && defined(HAVE_GNU_MALLOC)
 162 extern const char *pset_tag;
 163 # ifdef PSET_ID
 164 #   define PSET_TRACE pset_tag = SET_ID,
 165 # else
 166 #   define PSET_TRACE pset_tag = __FILE__,
 167 # endif
 168 #else /* !(DEBUG && HAVE_GNU_MALLOC) */
 169 #   define PSET_TRACE
 170 #endif /* !(DEBUG && HAVE_GNU_MALLOC) */
 171
 172 #endif