src/util/set.h

   1 /*
   2  * Copyright © 2009-2012 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *    Eric Anholt <eric@anholt.net>
  25  *
  26  */
  27
  28 #ifndef _SET_H
  29 #define _SET_H
  30
  31 #include <inttypes.h>
  32 #include <stdbool.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 struct set_entry {
  39    uint32_t hash;
  40    const void *key;
  41 };
  42
  43 struct set {
  44    void *mem_ctx;
  45    struct set_entry *table;
  46    uint32_t (*key_hash_function)(const void *key);
  47    bool (*key_equals_function)(const void *a, const void *b);
  48    uint32_t size;
  49    uint32_t rehash;
  50    uint32_t max_entries;
  51    uint32_t size_index;
  52    uint32_t entries;
  53    uint32_t deleted_entries;
  54 };
  55
  56 struct set *
  57 _mesa_set_create(void *mem_ctx,
  58                  uint32_t (*key_hash_function)(const void *key),
  59                  bool (*key_equals_function)(const void *a,
  60                                              const void *b));
  61 struct set *
  62 _mesa_set_clone(struct set *set, void *dst_mem_ctx);
  63
  64 void
  65 _mesa_set_destroy(struct set *set,
  66                   void (*delete_function)(struct set_entry *entry));
  67 void
  68 _mesa_set_resize(struct set *set, uint32_t entries);
  69 void
  70 _mesa_set_clear(struct set *set,
  71                 void (*delete_function)(struct set_entry *entry));
  72
  73 struct set_entry *
  74 _mesa_set_add(struct set *set, const void *key);
  75 struct set_entry *
  76 _mesa_set_add_pre_hashed(struct set *set, uint32_t hash, const void *key);
  77
  78 struct set_entry *
  79 _mesa_set_search_or_add(struct set *set, const void *key);
  80 struct set_entry *
  81 _mesa_set_search_or_add_pre_hashed(struct set *set, uint32_t hash,
  82                                    const void *key);
  83
  84 struct set_entry *
  85 _mesa_set_search(const struct set *set, const void *key);
  86 struct set_entry *
  87 _mesa_set_search_pre_hashed(const struct set *set, uint32_t hash,
  88                             const void *key);
  89
  90 struct set_entry *
  91 _mesa_set_search_and_add(struct set *set, const void *key, bool *replaced);
  92 struct set_entry *
  93 _mesa_set_search_and_add_pre_hashed(struct set *set, uint32_t hash,
  94                                     const void *key, bool *replaced);
  95
  96 void
  97 _mesa_set_remove(struct set *set, struct set_entry *entry);
  98 void
  99 _mesa_set_remove_key(struct set *set, const void *key);
 100
 101 struct set_entry *
 102 _mesa_set_next_entry(const struct set *set, struct set_entry *entry);
 103
 104 struct set_entry *
 105 _mesa_set_random_entry(struct set *set,
 106                        int (*predicate)(struct set_entry *entry));
 107
 108 struct set *
 109 _mesa_pointer_set_create(void *mem_ctx);
 110
 111 /**
 112  * This foreach function is safe against deletion, but not against
 113  * insertion (which may rehash the set, making entry a dangling
 114  * pointer).
 115  */
 116 #define set_foreach(set, entry)                                     \
 117    for (struct set_entry *entry = _mesa_set_next_entry(set, NULL);  \
 118         entry != NULL;                                              \
 119         entry = _mesa_set_next_entry(set, entry))
 120
 121 #ifdef __cplusplus
 122 } /* extern C */
 123 #endif
 124
 125 #endif /* _SET_H */