raphael/minishell
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

style: norming hashmap_env

Browse source
This commit is contained in:
Raphael 2024-09-19 12:11:22 +02:00
parent 36edf768bf
commit d2bcfa4522
1 changed files with 58 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

44
output/include/me/hashmap/hashmap_env.h
View file

@ -6,7 +6,7 @@
/* By: maiboyer <maiboyer@student.42.fr> +#+ +:+ +#+ */
/* +#+#+#+#+#+ +#+ */
/* Created: 2023/12/06 11:00:22 by maiboyer #+# #+# */
/* Updated: 2023/12/11 15:24:44 by maiboyer ### ########.fr */
/* Updated: 2024/09/19 12:11:03 by rparodi ### ########.fr */
/* */
/* ************************************************************************** */
@ -15,8 +15,6 @@
# define DEFAULT_BUCKETS 750
# include "me/hash/hasher.h"
# include "me/types.h"
# include <stddef.h>
@ -36,10 +34,9 @@ typedef struct s_kv_env
typedef void (*t_hash_env_fn)(t_hasher *hasher, t_str *key);
/// @typedef A function that drops a key-value pair
typedef void (*t_free_env_fn)(t_kv_env val);
/// @typedef A function that compares two keys and returns true if they are equal
/// @typedef A function that compares two keys & returns true if they are equal
typedef bool (*t_eq_env_fn)(t_str *lhs, t_str *rhs);
/// @struct A single entry in the hashmap
/// @var hash_id The hash of the key
/// @var kv The key-value pair
@ -68,20 +65,24 @@ typedef struct s_hashmap_env
t_free_env_fn free;
} t_hashmap_env;
/// @brief Creates a new hashmap with the given hash, comparison, and free functions
/// @brief Creates a new hashmap with the given hash, \
/// comparison, & free functions
/// @param hash The hash function
/// @param cmp The comparison function
/// @param free The free function
/// @return A new hashmap
t_hashmap_env *hmap_env_new(t_hash_env_fn hash, t_eq_env_fn cmp, t_free_env_fn free);
t_hashmap_env *hmap_env_new(\
t_hash_env_fn hash, t_eq_env_fn cmp, t_free_env_fn free);
/// @brief Creates a new hashmap with the given hash, comparison, and free functions
/// @brief Creates a new hashmap with the given hash, \
/// comparison, and free functions
/// @param hash The hash function
/// @param cmp The comparison function
/// @param free The free function
/// @param cap The number of buckets
/// @return A new hashmap
t_hashmap_env *hmap_env_new_with_buckets(t_hash_env_fn hash, t_eq_env_fn cmp, t_free_env_fn free, size_t cap);
t_hashmap_env *hmap_env_new_with_buckets(\
t_hash_env_fn hash, t_eq_env_fn cmp, t_free_env_fn free, size_t cap);
/// @brief Free the hashmap and all of its entries
/// @param hmap The hashmap to free
@ -101,7 +102,8 @@ bool hmap_env_insert(t_hashmap_env *hmap, t_str key, t_str value);
/// @brief Gets the value associated with the key
/// @param hmap The hashmap
/// @param key The key
/// @return The value associated with the key, or NULL if the key is not in the hashmap
/// @return The value associated with the key, \
/// or NULL if the key is not in the hashmap
t_str *hmap_env_get(t_hashmap_env *hmap, t_str *key);
/// @brief Removes the key-value pair from the hashmap
@ -116,23 +118,31 @@ void hmap_env_remove(t_hashmap_env *hmap, t_str *key);
/// @param prev The previous entry in the bucket
/// @return The entry, or NULL if the key is not in the hashmap
/// @note this is an internal function
t_entry_env *hmap_env_get_entry(t_hashmap_env *hmap, t_usize hash, t_str *key, t_entry_env **prev);
t_entry_env *hmap_env_get_entry(\
t_hashmap_env *hmap, t_usize hash, t_str *key, t_entry_env **prev);
/// @brief Iterates over the hashmap and calls the given function for each key-value pair
/// @brief Iterates over the hashmap & \
/// calls the given function for each key-value pair
/// @param self The hashmap
/// @param func The function to call
/// @param ctx The context to pass to the function
/// @return An error code
/// @note The iteration can be stopped by returning an error code from the function
t_error hmap_env_iter(t_hashmap_env *self, t_error (*func)(t_usize idx, const t_str *key, t_str *val, void *ctx), void *ctx);
/// @note The iteration can be stopped by returning \
/// an error code from the function
t_error hmap_env_iter(\
t_hashmap_env *self, t_error (*func)(\
t_usize idx, const t_str *key, t_str *val, void *ctx), void *ctx);
/// @brief Clone an entire hashmap, using the given function to duplicate the items
/// @brief Clone an entire hashmap, \
/// using the given function to duplicate the items
/// @param self The hashmap
/// @param func The function to call
/// @param ctx The context to pass to the function
/// @param out The cloned hashmap
/// @return An error code
t_error hmap_env_clone(t_hashmap_env *self, t_error (*clone)(const t_kv_env *val, void *ctx, t_kv_env *out), void *ctx, t_hashmap_env **out);
t_error hmap_env_clone(\
t_hashmap_env *self, t_error (*clone)(\
const t_kv_env *val, void *ctx, t_kv_env *out), \
void *ctx, t_hashmap_env **out);
#endif