/*
 * Copyright (C) 2023 Johnny Richard
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
#ifndef HASHMAP_H
#define HASHMAP_H

#include <stdbool.h>
#include <stdint.h>
#include <string.h>

#define HASHMAP_INITIAL_CAPACITY 32

#define U32_FNV1A_PRIME 0x01000193
#define U32_FNV1A_OFFSET_BASIS 0x811c9dc5

typedef struct hashmap_t hashmap_t;
typedef struct hashmap_bucket_t hashmap_bucket_t;
typedef struct hashmap_entry_t hashmap_entry_t;

typedef struct hashmap_t
{
  hashmap_entry_t *entries;
  uint32_t capacity;
} hashmap_t;

typedef struct hashmap_entry_t
{
  char *key;
  void *value;
  uint32_t hash;
  hashmap_entry_t *next;
} hashmap_entry_t;

/**
 * @brief: Create a new hashmap with HASHMAP_INITIAL_CAPACITY
 */
hashmap_t *
hashmap_new(void);

/**
 * @brief: Store a new entry into the hashmap.
 *
 * @param key:
 *     The function copies the key in order to have his own key.
 * @param value:
 *     Value of the hashmap entry, the hashmap doesn't have the ownership.
 * @return boolean
 *     true if the object has been added to the hashmap otherwise false.
 */
bool
hashmap_put(hashmap_t *map, char *key, void *value);

void *
hashmap_get(hashmap_t *map, char *key);

/**
 * @brief: Destroy the hashmap and entries. (including keys)
 */
void
hashmap_destroy(hashmap_t *map);

#endif /* HASHMAP_H */