code.delx.au - pulseaudio/blob - src/pulsecore/hashmap.h

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