hash.h

Go to the documentation of this file.

/*
  Copyright 2011-2015 David Robillard <http://drobilla.net>
 
  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above
  copyright notice and this permission notice appear in all copies.
 
  THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
 
#ifndef ZIX_HASH_H
#define ZIX_HASH_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "zix/common.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
typedef struct ZixHashImpl ZixHash;

typedef uint32_t (*ZixHashFunc)(const void* value);

typedef void (*ZixHashVisitFunc)(void* value,
                                 void* user_data);

ZIX_API ZixHash*
zix_hash_new(ZixHashFunc  hash_func,
             ZixEqualFunc equal_func,
             size_t       value_size);

ZIX_API void
zix_hash_free(ZixHash* hash);

ZIX_API size_t
zix_hash_size(const ZixHash* hash);

ZIX_API ZixStatus
zix_hash_insert(ZixHash*     hash,
                const void*  value,
                const void** inserted);

ZIX_API ZixStatus
zix_hash_remove(ZixHash*    hash,
                const void* value);

ZIX_API const void*
zix_hash_find(const ZixHash* hash,
              const void*    value);

ZIX_API void
zix_hash_foreach(ZixHash*         hash,
                 ZixHashVisitFunc f,
                 void*            user_data);

 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif  /* ZIX_HASH_H */