hashmap.h

Go to the documentation of this file.

 
#pragma once
 
#include "klib/list.h"
 
// == OPAQUE TYPES ============================================================
typedef struct hashmap_entry_t hashmap_entry_t;
typedef struct hashmap_t hashmap_t;
 
// == HASHMAP FUNCTIONS =======================================================
typedef unsigned int (*hashmap_hash_t)(const void *key);
typedef int (*hashmap_comp_t)(const void *a, const void *b);
typedef void *(*hashmap_dupe_t)(const void *);
typedef void (*hashmap_free_t)(void *);
 
// == HASHMAP KEY MANAGEMENT FUNCTIONS ========================================
unsigned int hashmap_int_hash(const void *key);
 
int hashmap_int_comp(const void *a, const void *b);
 
unsigned int hashmap_str_hash(const void *key);
 
int hashmap_str_comp(const void *a, const void *b);
 
void *hashmap_do_not_duplicate(const void *value);
 
void hashmap_do_not_free(void *value);
 
// == HASHMAP CREATION AND DESTRUCTION ========================================
hashmap_t *hashmap_create(
    unsigned int size,
    hashmap_hash_t hash_fun,
    hashmap_comp_t comp_fun,
    hashmap_dupe_t dupe_fun,
    hashmap_free_t key_free_fun);
 
hashmap_t *hashmap_create_str(unsigned int size);
 
hashmap_t *hashmap_create_int(unsigned int size);
 
void hashmap_free(hashmap_t *map);
 
// == HASHMAP ACCESS FUNCTIONS ================================================
void *hashmap_set(hashmap_t *map, const void *key, void *value);
 
void *hashmap_get(hashmap_t *map, const void *key);
 
void *hashmap_remove(hashmap_t *map, const void *key);
 
int hashmap_is_empty(hashmap_t *map);
 
int hashmap_has(hashmap_t *map, const void *key);
 
list_t *hashmap_keys(hashmap_t *map);
 
list_t *hashmap_values(hashmap_t *map);