src/polypcore/hashmap.h

   1 #ifndef foohashmaphfoo
   2 #define foohashmaphfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of polypaudio.
   8
   9   polypaudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU Lesser General Public License as published
  11   by the Free Software Foundation; either version 2 of the License,
  12   or (at your option) any later version.
  13
  14   polypaudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with polypaudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 /* Simple Implementation of a hash table. Memory management is the
  26  * user's job. It's a good idea to have the key pointer point to a
  27  * string in the value data. */
  28
  29 typedef struct pa_hashmap pa_hashmap;
  30
  31 /* Create a new hashmap. Use the specified functions for hashing and comparing objects in the map */
  32 pa_hashmap *pa_hashmap_new(unsigned (*hash_func) (const void *p), int (*compare_func) (const void*a, const void*b));
  33
  34 /* Free the hash table. Calls the specified function for every value in the table. The function may be NULL */
  35 void pa_hashmap_free(pa_hashmap*, void (*free_func)(void *p, void *userdata), void *userdata);
  36
  37 /* Returns non-zero when the entry already exists */
  38 int pa_hashmap_put(pa_hashmap *h, const void *key, void *value);
  39 void* pa_hashmap_get(pa_hashmap *h, const void *key);
  40
  41 /* Returns the data of the entry while removing */
  42 void* pa_hashmap_remove(pa_hashmap *h, const void *key);
  43
  44 unsigned pa_hashmap_size(pa_hashmap *h);
  45
  46 /* May be used to iterate through the hashmap. Initially the opaque
  47    pointer *state has to be set to NULL. The hashmap may not be
  48    modified during iteration. The key of the entry is returned in
  49    *key, if key is non-NULL. After the last entry in the hashmap NULL
  50    is returned. */
  51 void *pa_hashmap_iterate(pa_hashmap *h, void **state, const void**key);
  52
  53 #endif