style: norming vec_str
This commit is contained in:
Raphael
parent
43f0f2aa69
commit
7b5a4aafa3
1 changed files with 54 additions and 52 deletions
|
|
@ -6,14 +6,13 @@
|
|||
/* By: maiboyer <maiboyer@student.42.fr> +#+ +:+ +#+ */
|
||||
/* +#+#+#+#+#+ +#+ */
|
||||
/* Created: 2023/12/04 18:46:53 by maiboyer #+# #+# */
|
||||
/* Updated: 2023/12/09 17:53:00 by maiboyer ### ########.fr */
|
||||
/* Updated: 2024/09/19 14:31:26 by rparodi ### ########.fr */
|
||||
/* */
|
||||
/* ************************************************************************** */
|
||||
|
||||
#ifndef VEC_STR_H
|
||||
# define VEC_STR_H
|
||||
|
||||
|
||||
# include "me/types.h"
|
||||
|
||||
/// @brief A function that takes two t_str and compare them
|
||||
|
|
@ -22,15 +21,13 @@ typedef bool (*t_vec_str_sort_fn)(t_str *, t_str *);
|
|||
typedef void (*t_free_str_item)(t_str);
|
||||
|
||||
/// @brief A dynamic array of t_str
|
||||
typedef struct s_vec_str t_vec_str;
|
||||
|
||||
struct s_vec_str
|
||||
{
|
||||
t_free_str_item free_func;
|
||||
t_usize len;
|
||||
t_usize capacity;
|
||||
t_str *buffer;
|
||||
};
|
||||
} t_vec_str;
|
||||
|
||||
struct s_vec_str_splice_arguments
|
||||
{
|
||||
|
|
@ -45,8 +42,9 @@ struct s_vec_str_splice_arguments
|
|||
/// elements)
|
||||
/// @param free_function The function that will be used to free the elements of
|
||||
/// the vec_str
|
||||
t_vec_str vec_str_new(t_usize capacity,
|
||||
t_free_str_item free_function);
|
||||
t_vec_str vec_str_new(\
|
||||
t_usize capacity, t_free_str_item free_function);
|
||||
|
||||
/// @brief Push an element to the last position of the vec_str
|
||||
/// @param vec The vec_str to push the element to
|
||||
/// @param element The element to push
|
||||
|
|
@ -56,8 +54,8 @@ t_error vec_str_push(t_vec_str *vec, t_str element);
|
|||
/// @param vec The vec_str to push the element to
|
||||
/// @param element The element to push
|
||||
/// @note This operation is O(n)
|
||||
t_error vec_str_push_front(t_vec_str *vec,
|
||||
t_str element);
|
||||
t_error vec_str_push_front(\
|
||||
t_vec_str *vec, t_str element);
|
||||
|
||||
/// @brief Get the last element from the vec_str, and remove it from the
|
||||
/// vec_str
|
||||
|
|
@ -72,7 +70,8 @@ t_error vec_str_pop(t_vec_str *vec, t_str *value);
|
|||
/// @param[out] out The first element of the vec_str
|
||||
/// @return true if the operation failed, false otherwise
|
||||
/// @note This operation is O(n)
|
||||
t_error vec_str_pop_front(t_vec_str *vec, t_str *value);
|
||||
t_error vec_str_pop_front(\
|
||||
t_vec_str *vec, t_str *value);
|
||||
|
||||
/// @brief Free the vector and all its elements
|
||||
/// @param vec The vec_str to free
|
||||
|
|
@ -82,16 +81,17 @@ void vec_str_free(t_vec_str vec);
|
|||
/// @param vec The vec_str to reserve
|
||||
/// @param wanted_capacity The minimum capacity to reserve
|
||||
/// @return true if the operation failed, false otherwise
|
||||
t_error vec_str_reserve(t_vec_str *vec,
|
||||
t_usize wanted_capacity);
|
||||
t_error vec_str_reserve(\
|
||||
t_vec_str *vec, t_usize wanted_capacity);
|
||||
|
||||
/// @brief Run the function and returns the index of the first element that
|
||||
/// returns true
|
||||
/// @param vec The vec_str to search in
|
||||
/// @param fn The function to run on each element
|
||||
/// @param[out] index The index of the first element that returns true
|
||||
t_error vec_str_find(t_vec_str *vec,
|
||||
bool (*fn)(const t_str *), t_usize *index);
|
||||
t_error vec_str_find(\
|
||||
t_vec_str *vec, bool (*fn)(\
|
||||
const t_str *), t_usize *index);
|
||||
|
||||
/// @brief Run the function and returns the index of the first element that
|
||||
/// returns true, but starting at index starting_index
|
||||
|
|
@ -99,9 +99,9 @@ t_error vec_str_find(t_vec_str *vec,
|
|||
/// @param fn The function to run on each element
|
||||
/// @param starting_index The index to start the search from
|
||||
/// @param[out] index The index of the first element that returns true
|
||||
t_error vec_str_find_starting(t_vec_str *vec,
|
||||
bool (*fn)(const t_str *),
|
||||
t_usize starting_index, t_usize *index);
|
||||
t_error vec_str_find_starting(\
|
||||
t_vec_str *vec, bool (*fn)(\
|
||||
const t_str *), t_usize starting_index, t_usize *index);
|
||||
|
||||
/// @brief Run the function on every element of the vec_str and returns
|
||||
/// if all elements returned true
|
||||
|
|
@ -110,8 +110,9 @@ t_error vec_str_find_starting(t_vec_str *vec,
|
|||
/// @param[out] result The result of the operation
|
||||
/// @return true if the operation failed, false otherwise
|
||||
/// @note If the vec_str is empty, result will be true
|
||||
t_error vec_str_all(t_vec_str *vec,
|
||||
bool (*fn)(const t_str *), bool *result);
|
||||
t_error vec_str_all(\
|
||||
t_vec_str *vec, bool (*fn)(\
|
||||
const t_str *), bool *result);
|
||||
|
||||
/// @brief Run the function on every element of the vec_str and returns
|
||||
/// if any element returned true
|
||||
|
|
@ -120,17 +121,17 @@ t_error vec_str_all(t_vec_str *vec,
|
|||
/// @param[out] result The result of the operation
|
||||
/// @return true if the operation failed, false otherwise
|
||||
/// @note If the vec_str is empty, result will be false
|
||||
t_error vec_str_any(t_vec_str *vec,
|
||||
bool (*fn)(const t_str *), bool *result);
|
||||
t_error vec_str_any(\
|
||||
t_vec_str *vec, bool (*fn)(\
|
||||
const t_str *), bool *result);
|
||||
|
||||
/// @brief Run the function on every element of the vec_str
|
||||
/// @param vec The vec_str to iterate over
|
||||
/// @param fn The function to run on each element
|
||||
/// @param state The state to pass to the function
|
||||
void vec_str_iter(t_vec_str *vec,
|
||||
void (*fn)(t_usize index, t_str *value,
|
||||
void *state),
|
||||
void *state);
|
||||
void vec_str_iter(\
|
||||
t_vec_str *vec, void (*fn)(\
|
||||
t_usize index, t_str *value, void *state), void *state);
|
||||
|
||||
/// @brief Reverse the order of the elements in the vec_str
|
||||
/// @param vec The vec_str to reverse
|
||||
|
|
@ -139,8 +140,8 @@ void vec_str_reverse(t_vec_str *vec);
|
|||
/// @brief Sort the elements of the vec_str
|
||||
/// @param vec The vec_str to sort
|
||||
/// @param is_sorted The function to use to compare the elements
|
||||
void vec_str_sort(t_vec_str *vec,
|
||||
t_vec_str_sort_fn is_sorted);
|
||||
void vec_str_sort(\
|
||||
t_vec_str *vec, t_vec_str_sort_fn is_sorted);
|
||||
|
||||
/// @brief Get a pointer to the last element of the vec_str
|
||||
/// @param vec The vec_str to get the element from
|
||||
|
|
@ -161,14 +162,15 @@ t_str *vec_str_last(t_vec_str *vec);
|
|||
/// @brief Perform a simple bytewise copy into the other vector
|
||||
/// @param vec The vec_str to be copied from
|
||||
/// @param dest The vec_str to be copied to
|
||||
void vec_str_copy_into(t_vec_str *vec, t_vec_str *dest);
|
||||
void vec_str_copy_into(\
|
||||
t_vec_str *vec, t_vec_str *dest);
|
||||
|
||||
/// read code lol
|
||||
void vec_str_splice(t_vec_str *self,
|
||||
struct s_vec_str_splice_arguments args);
|
||||
void vec_str_splice(\
|
||||
t_vec_str *self, struct s_vec_str_splice_arguments args);
|
||||
|
||||
struct s_vec_str_splice_arguments vec_str_splice_args(
|
||||
t_usize index, t_usize old_count, t_usize new_count,
|
||||
struct s_vec_str_splice_arguments vec_str_splice_args( \
|
||||
t_usize index, t_usize old_count, t_usize new_count, \
|
||||
const t_str *elements);
|
||||
|
||||
#endif
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue