hashMap.h

Go to the documentation of this file.

 
#ifndef _HASH_MAP_H_
#define _HASH_MAP_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "linked_list.h"
 
typedef uint32_t (*hashFunction_t)(const void* data);
 
typedef bool (*eqFunction_t)(const void* a, const void* b);
 
// Forward-declared internal structs
typedef struct hashBucket hashBucket_t;
typedef struct hashIterState hashIterState_t;
 
typedef struct
{
    const void* key;
    void* value;
 
    hashIterState_t* _state;
} hashIterator_t;
 
typedef struct
{
    int size;
 
    int count;
 
    hashBucket_t* values;
 
    hashFunction_t hashFunc;
 
    eqFunction_t eqFunc;
} hashMap_t;
 
// Default hash functions
uint32_t hashString(const void* str);
bool strEq(const void* a, const void* b);
 
// Helper functions for using custom key types
uint32_t hashBytes(const uint8_t* bytes, size_t length);
bool bytesEq(const uint8_t* a, size_t aLength, const uint8_t* b, size_t bLength);
 
// Helper functions for using int or pointer keys
uint32_t hashInt(const void* intKey);
bool intsEq(const void* keyA, const void* keyB);
 
void hashPut(hashMap_t* map, const char* key, void* value);
void* hashGet(hashMap_t* map, const char* key);
void* hashRemove(hashMap_t* map, const char* key);
 
void hashPutBin(hashMap_t* map, const void* key, void* value);
void* hashGetBin(hashMap_t* map, const void* key);
void* hashRemoveBin(hashMap_t* map, const void* key);
 
void hashInit(hashMap_t* map, int initialSize);
void hashInitBin(hashMap_t* map, int initialSize, hashFunction_t hashFunc, eqFunction_t eqFunc);
void hashDeinit(hashMap_t* map);
 
bool hashIterate(const hashMap_t* map, hashIterator_t* iterator);
bool hashIterRemove(hashMap_t* map, hashIterator_t* iter);
void hashIterReset(hashIterator_t* iterator);
 
void hashReport(const hashMap_t* map);
 
#endif